Open sarthak247 opened 7 months ago
Oh I didn't realize we were supposed to use doc-builder
to preview the course. I've just been using this VSCode plugin
https://marketplace.visualstudio.com/items?itemName=xyc.vscode-mdx-preview
EDIT: OH this button doesn't work for rendering LaTex with $...$
syntax as recommended in the README? Maybe because that's coming from Github MathJax rendering? https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions
Thank you for that. I'll have a look at that VSCode extension. I just thought of going with doc-builder
for now as I was following the style guide and structure from HF Audio Course and they were using doc-builder to render the course locally so I thought something similar could be used here as well.
Pinging @merveenoyan and @MKhalusova , as they probably know most about doc-builder
To publish on hf.co/learn, we indeed use the doc-builder
. You can learn more about it in its repo: https://github.com/huggingface/doc-builder
It does require that all the .md
files in the folder it builds are also in the _toctree.yml
. Both solutions suggested will work. I would also recommend having an introduction.md
in each chapter as a "landing" page for each chapter.
As a third option, while the work is still in progress, the content of readme files can move into introduction files. Later you can turn them into actual introduction pages with "what to expect" paragraphs, for instance.
If we try to render the course to preview how our added content looks like, it throws the following error
Explanation: This is because there have been README files added to each chapter. However, these README files are not present in the
_toctree.yml
.Why it's important: Being able to render the course locally is important as it can give us a rough overview of how the content looks like.
Possible solutions could be:
Open for discussion from other members :v: