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.

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

Markdown-native toctrees #3

Open
kousu opened this issue Oct 26, 2021 · 0 comments
Open

Markdown-native toctrees #3

kousu opened this issue Oct 26, 2021 · 0 comments

Comments

@kousu
Copy link

kousu commented Oct 26, 2021

Hi! I found your research on SO. Thanks so much for trail-blazing this. I was getting ready to figure out how to implement your solution when I noticed that https://sphinx-themes.org/sample-sites/sphinx-book-theme is entirely written in markdown. Here's how they seem to have done it:

  • in index.md (instead of index.rst) add
  • a code block tagged with type toctree:
 ```{toctree}
 :maxdepth: 1
 :caption: Topic Areas
 
 tutorials/get-started
 customize/index
 content-blocks
 notebooks
 launch
 ``

We can see the full working docs at https://github.com/executablebooks/sphinx-book-theme/tree/master/docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant