/gatsby-starter-primer-wiki

A gatsby theme primer wiki starter, with best wiki support. Build your own digital garden.

Primary LanguageJavaScript

Gatsby Starter for Gatsby Theme Primer Wiki

👋A Gatsbyjs starter that use gatsby-theme-primer-wiki

Examples

Features

  • Support Local search, full-text search.
  • Support Graph Visualisation with canvas.
  • Support Tags, Tags First, Generating tag pages, also connecting with graph visualisation.
  • Support Gitbook styled SUMMARY.md for custom sidebar.
  • Support [[WikiLink]], But you'd better use Link Reference Definitions with extensions, "foam.edit.linkReferenceDefinitions": "withExtensions"
  • Support Light/Dark Theme
  • Custom Header Nav Items
  • Nested sidebar
  • Support Google Analytics
  • Support Sitemap/Robot
  • SEO optimization

🚀 Quick start

  1. Create a Gatsby site.

    Use the Gatsby CLI (install instructions) to create a new site, specifying the blog starter.

    # create a new Gatsby site using the blog starter
gatsby new wiki https://github.com/theowenyoung/gatsby-starter-primer-wiki

  2. Start developing.

    Navigate into your new site’s directory and start it up.

    cd wiki/
npm start

  3. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the wiki directory in your code editor of choice and edit content. Save your changes and the browser will update in real time!

  4. Learn more