Skip to content

Migrate to Docusaurus #236

Description

@qwertyvipul

The current site misses out on a few important features now standard across modern documentation sites. Such as:

  1. Sidebar for quick navigation between pages and better context of the site heirarchy,
  2. Previous and next link to pages,
  3. Fixed TOC on top right for better context of current position in the page content hierarchy, and
  4. Search

This causes significant inconvenience to developers browsing the site, especially when in need for quick reference. Proposing to migrate from Metalsmith to Docusaurus as it provides the above features out of the box along with many others.

I tried this migration with my fork, and was able to do it with minimal changes in the existing markdown contents and without breaking the existing links and redirects. Refer:

  1. Resulting site
  2. Changelog

I will go ahead a raise a PR for the migration without Search feature. Read here for the Docusaurus search support.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions