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

Upgrade documentation to MkDocs #136

Open
sebastiangrimberg opened this issue Nov 21, 2023 · 0 comments
Open

Upgrade documentation to MkDocs #136

sebastiangrimberg opened this issue Nov 21, 2023 · 0 comments
Labels
ci Related to continuous integration (CI) and/or GitHub Actions documentation Improvements or additions to documentation

Comments

@sebastiangrimberg
Copy link
Contributor

The use of Julia's Documenter.jl was an early decision that got us up and running quickly, but we aren't tied to it and it doesn't provide any Julia-specific functionality. Using MkDocs provides better visual appeal as well as a larger feature set (increased section depth, better math mode support, for examples).
@sebastiangrimberg sebastiangrimberg added documentation Improvements or additions to documentation ci Related to continuous integration (CI) and/or GitHub Actions labels Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
ci Related to continuous integration (CI) and/or GitHub Actions documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sebastiangrimberg