https://github.com/hikerpig/gatsby-project-kb

Developing gatsby-theme-kb, a Gatsby theme for publishing Knowledge Base.
https://github.com/hikerpig/gatsby-project-kb

digital-garden gatsby-plugin gatsby-theme knowledge-base personal-wiki

Last synced: about 1 month ago
JSON representation

Developing gatsby-theme-kb, a Gatsby theme for publishing Knowledge Base.

• Host: GitHub
• URL: https://github.com/hikerpig/gatsby-project-kb
• Owner: hikerpig
• License: mit
• Created: 2020-12-04T10:48:07.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T07:48:39.000Z (3 months ago)
• Last Synced: 2024-07-21T21:37:19.429Z (about 2 months ago)
• Topics: digital-garden, gatsby-plugin, gatsby-theme, knowledge-base, personal-wiki
• Language: TypeScript
• Homepage: https://gatsby-project-kb.vercel.app/
• Size: 2.04 MB
• Stars: 62
• Watchers: 4
• Forks: 15
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - hikerpig/gatsby-project-kb - Developing gatsby-theme-kb, a Gatsby theme for publishing Knowledge Base. (others)

README

        
gatsby-project-kb

===

Here is a project developing a gatsby theme for publishing **K**nowledge **B**ase.

You can check out the demo and [documentation](https://gatsby-project-kb.vercel.app/).

If you are looking for `gatsby-theme-kb`, go to directory [packages/gatsby-theme-kb](https://github.com/hikerpig/gatsby-project-kb/tree/master/packages/gatsby-theme-kb) for more detailed docs.

![](https://i.loli.net/2021/01/28/cD6QRIZqUoum4Tf.png)

# Development

File structure:

```

├── demo // the demo site's code

├── packages

    └── gatsby-theme-kb // the Gatsby theme

├── yarn.lock

```

This is a common structure for developing Gatsby theme using yarn workspace. You can check more on Gatsby official tutorial [Building a Theme](https://www.gatsbyjs.com/tutorial/building-a-theme/).

## Run it locally

```

yarn # install dependencies

yarn dev # start devlopment

```

# Support

Feel free to open issues if you have any problems or suggestions for this project, I will do my best to solve them in my spare time.

If you find it useful and find yourself in a mood of sunshine, you may support me a little pack of coffee beans.

I like [Geisha](https://www.wikiwand.com/en/Geisha_\(coffee\)), you will like it, too.