jannikbuschke / gatsby-antd-docs

A gatsby starter for a technical documentation website

Home Page:https://www.jannikbuschke.de/gatsby-antd-docs/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sample: https://www.jannikbuschke.de/gatsby-antd-docs/

Gatsby Ant-Design Documentation Starter

Forked from https://github.com/cvluca/gatsby-starter-markdown.

This starter is boilerplate for (technical) documentation websites optionally accompanied by a blog (you can use it forever you want of course).

Getting started

npm install gatsby -g
gatsby new my-docs https://github.com/jannikbuschke/gatsby-antd-docs
cd my-docs
npm install
npm run start

Visit http://localhost:8000.

Edit files in /content/docs and see live updates.

Features

  • Ant Design
  • Typescript
  • Markdown
  • MDX
  • Syntax highlighting
  • Latex

Roadmap

  • Blog feature / second content type
  • Improved typings
  • Improved responsiveness
  • Add Search
  • svg intergration for excalidraw

Hosting

In order to host the site the sites path needs to be put into gatsby-config.js export object on to the property pathPrefix. Then run

npm run build

and copy the content of the public folder to the webspace.

License

MIT

About

A gatsby starter for a technical documentation website

https://www.jannikbuschke.de/gatsby-antd-docs/

License:MIT License


Languages

Language:TypeScript 69.2%Language:JavaScript 30.8%