Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theowenyoung/gatsby-starter-primer-wiki
A gatsby theme primer wiki starter, with best wiki support. Build your own digital garden.
https://github.com/theowenyoung/gatsby-starter-primer-wiki
digital-garden gatsbyjs knowledge-base wiki
Last synced: 20 days ago
JSON representation
A gatsby theme primer wiki starter, with best wiki support. Build your own digital garden.
- Host: GitHub
- URL: https://github.com/theowenyoung/gatsby-starter-primer-wiki
- Owner: theowenyoung
- Created: 2021-08-31T14:34:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-09T07:01:03.000Z (over 2 years ago)
- Last Synced: 2024-10-04T19:43:14.725Z (about 1 month ago)
- Topics: digital-garden, gatsbyjs, knowledge-base, wiki
- Language: JavaScript
- Homepage: https://demo-gatsby-starter-primer-wiki.owenyoung.com/
- Size: 1.32 MB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gatsby Starter for Gatsby Theme Primer Wiki
**👋A Gatsbyjs starter that use [gatsby-theme-primer-wiki](https://github.com/theowenyoung/gatsby-theme-primer-wiki)**
## Examples
- [Demo](https://demo-wiki.owenyoung.com) - ([Source](https://github.com/theowenyoung/gatsby-theme-primer-wiki/tree/main/example))
- [Everything I Know by Owen](https://wiki.owenyoung.com/) - ([Source](https://github.com/theowenyoung/wiki))
- [Foam Demo](https://demo-foam.owenyoung.com/) - ([Source](https://github.com/theowenyoung/foam-template-gatsby-theme-primer-wiki))
- [Gatsby Starter Demo](https://demo-gatsby-starter-primer-wiki.owenyoung.com/) - ([Source](https://github.com/theowenyoung/gatsby-starter-primer-wiki))
## 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](https://docs.gitbook.com/integrations/github/content-configuration#summary) styled `SUMMARY.md` for custom sidebar.
- Support `[[WikiLink]]`, But you'd better use [Link Reference Definitions](https://foambubble.github.io/foam/features/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](https://www.gatsbyjs.com/docs/tutorial/part-0/#gatsby-cli)) to create a new site, specifying the blog starter.
```shell
# create a new Gatsby site using the blog starter
gatsby new wiki https://github.com/theowenyoung/gatsby-starter-primer-wiki
```
1. **Start developing.**
Navigate into your new site’s directory and start it up.
```shell
cd wiki/
npm start
```
1. **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](https://www.gatsbyjs.com/tutorial/part-five/#introducing-graphiql)._
Open the `wiki` directory in your code editor of choice and edit `content`. Save your changes and the browser will update in real time!
2. **Learn more**
- [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [Tutorials](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [Guides](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [API Reference](https://www.gatsbyjs.com/docs/api-reference/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)