Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add project: highlight yaml examples #369

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add project: highlight yaml examples #369

wants to merge 10 commits into from

Commits on Jun 6, 2024

  1. Add project: show more yaml examples 

    I used tabs to show different examples of YAML files, as suggested in #184.
It looks great for an initial interactive approach.

I like the tabs over the dropdown because it gives the user a clear idea there
are more than Sphinx and MkDocs tools supported, which is a good marketing
strategy, in my opinion.

It also adds an "Others" option that's more generic and shows how to use
`build.commands` in a generic way: install dependencies, build, copy assets
under `$READTHDOCS_OUTPUT` directory.
    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    570abd6 View commit details
    Browse the repository at this point in the history

  2. Add project: highlight yaml examples 

    I used `highlight.js` to highlight the examples when importing a project.
It requires importing a CSS file that I'm not sure where to put it yet.

https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/dark.min.css

Besides, I need to know where to place the small chunk of JS code that I added
to make this work.

Based on #368
    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    b7c1209 View commit details
    Browse the repository at this point in the history

  3. Using the correct pattern to add js

    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    ee5450a View commit details
    Browse the repository at this point in the history

  4. NPM package

    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    e0f8e15 View commit details
    Browse the repository at this point in the history

  5. Style sheet for highlight component

    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    2969bc6 View commit details
    Browse the repository at this point in the history

  6. Import less file successfully

    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    9d23129 View commit details
    Browse the repository at this point in the history

  7. HTML structure for highlight

    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    9aad0dd View commit details
    Browse the repository at this point in the history

  8. Add deleted files by mistake 

    npm run build
    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    42e9185 View commit details
    Browse the repository at this point in the history

  9. Remove debug lines

    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    46ff6bf View commit details
    Browse the repository at this point in the history

  10. Minor comments

    @humitos
    humitos committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    6e4fcfa View commit details
    Browse the repository at this point in the history