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

Configure a Jekyll-powered documentation site similar to Ruby LSP's #2180

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Feb 3, 2025

Motivation

This PR attempts replicate a documentation website similar to Ruby LSP's with the same theme and similar settings.

The content are all extracted from the current readme without any modification as I think that should belong to another PR.

The goal of having a dedicated doc site is to:

  • Split content into pages to make them easier to consume, while still having good navigation between them through both navbar and searching.
  • Create more space for more contents (e.g. a dedicated page for a custom DSL compiler guide)

Implementation

Tests

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

Successfully merging this pull request may close these issues.

1 participant