Bootstrap basic example contents for 1.0 #1
Conversation
|
@ericholscher thanks for the review! tl;dr This was a quick draft to open the arena on the main question here: Do we want a "basic" mkdocs example WITH API docs or not? I think it's great to use an example with API docs since it shows the big benefits of having code and documentation live alongside and with the same release lifecycle + reflects the basic sphinx example projects pretty much 1:1. I understand, though, that there are some strong feelings of why MkDocs should not even support API documentation as a core thing, and that some people just think that we are better off without auto-generated docs. I can find the reference later. Yet, I think that we can make a choice to say that this basic example will anticipate API docs as a basic component. |
|
In general we don't focus too much priority on mkdocs. So I wouldn't spend a huge amount of time on it, but making it match our Sphinx example makes sense to me. I don't think we need to get bogged down in philosophical debates. |
There was a problem hiding this comment.
This is now pretty much where I would see it for a 1.0 -- I never managed to make highlight.js work locally for the mkdocs readthedocs theme, was it was advertised to. Maybe it'll work on Read the Docs 🤷
It's interesting that even for a basic example, I would argue that MkDocs needs extensions. However, on the bright side, there's a lot of those.
No description provided.