Skip to content
This repository has been archived by the owner on Jun 14, 2018. It is now read-only.

Adopt some existing documentation system #92

Open
borekb opened this issue Jan 19, 2017 · 6 comments
Open

Adopt some existing documentation system #92

borekb opened this issue Jan 19, 2017 · 6 comments
Assignees

Comments

@borekb
Copy link
Member

borekb commented Jan 19, 2017

In the long run, we should not maintain our own project just to render the documentation. A year ago, I didn't find anything quite suitable but I'll open this issue to gather some links to interesting projects.

Previous discussion about server-side rendering vs. static site generation: #12

Good docs

For inspiration:

Tools

  • Algolia – search, alternative to Google Custom Search
@borekb borekb self-assigned this Jan 19, 2017
@borekb borekb changed the title Static generation alternatives Adopt some existing documentation system May 6, 2017
@borekb
Copy link
Member Author

borekb commented May 6, 2017

Some other ideas:

Other resources:

  • Beautiful Docs – a list to nice documentations & tools to generate them

@borekb
Copy link
Member Author

borekb commented May 12, 2017

Webpack 2 has a very nice documentation:

  • Edit via GitHub
  • Inline Gitter in top right corner, sort of like Intercom

@borekb
Copy link
Member Author

borekb commented May 31, 2017

Next.js intro is nice: https://learnnextjs.com/basics/getting-started

@borekb
Copy link
Member Author

borekb commented Jun 4, 2017

  • DocFX – generates MS docs, maybe even VSCode docs?
  • docsify – client-side solution (fetches Markdown to browser, renders there)
  • MkDocs – another quite popular solution, there's nothing stunning about it at first sight.

@borekb
Copy link
Member Author

borekb commented Aug 11, 2017

Bootstrap 4 docs don't seem bad.

@borekb
Copy link
Member Author

borekb commented Mar 14, 2018

We now use MkDocs + mkdocs-material for docs.versionpress.com (see PR https://github.com/versionpress/platform/pull/1715) and it is awesome. This will be the way to go for docs.versionpress.net as well.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant