Skip to content

talkyjs/talkyjs.dev

Repository files navigation

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

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published