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

Start documentation site #713

Open
JakeWharton opened this issue Feb 20, 2025 · 2 comments
Open

Start documentation site #713

JakeWharton opened this issue Feb 20, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@JakeWharton
Copy link
Owner

  • Markdown-based
  • Looks good without much effort
  • NOT be mkdocs + material theme
  • Static HTML, no SPA garbage
  • Anchor links without JS
  • Static search would be nice
  • Compile-time syntax highlighting
    • Bonus if it's tree-sitter based
@JakeWharton JakeWharton added the documentation Improvements or additions to documentation label Feb 20, 2025
@DRSchlaubi
Copy link

Writerside
Markdown-based: ✅
Looks good without much effort: ✅
NOT be mkdocs + material theme: ✅
Static HTML, no SPA garbage: ✅
Anchor links without JS: ✅
Static search would be nice: Sadly, only via Algolia, however, 10k searches a month are free
Compile-time syntax highlighting: Through the Writerside idea plugin

@JakeWharton
Copy link
Owner Author

Good suggestion! I haven't looked at it since I tried it two years ago when it came out.

@JakeWharton JakeWharton mentioned this issue Mar 26, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JakeWharton @DRSchlaubi