Skip to content
This repository was archived by the owner on Jul 28, 2024. It is now read-only.
This repository was archived by the owner on Jul 28, 2024. It is now read-only.

Use MkDocs for docs.versionpress.net #1332

@borekb

Description

@borekb

Our docs are currently powered by versionpress/docs-site, a small Node.js app that serves a bunch of Markdown files – currently the contents of /docs/content folder in this repo. The idea was that we'd be able to switch versions of the documentation and language versions but the reality is that these features are not used and static site generation would be much simpler.

Specifically, MkDocs + mkdocs-material is a nice combo that we already use for our ".com" docs and would also provide all we really need for ".net" docs:

  • Markdown source files
  • Search
  • Navigation: menu & prev/next
  • Design options

If someone wanted to take this, it would be great. What should happen as part of the PR:

  • Update the Markdown files and their structure for MkDocs
  • Move the release notes to GitHub releases and/or CHANGELOG.md We'll keep them in the docs for now
  • Ideally keep the design. I quite like the distinct, although relatively old-school looks of our docs.
  • Update README / deployment instructions
    • The site is now deployed to GitHub Pages.

Related: versionpress/docs-site#92


🏁

Summary:

New docs:

image

Original docs:

image

Blog post.

Metadata

Metadata

Assignees

Labels

scope: docsMarkdown documentation, public docs, READMEs

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions