Giters

palantir / documentalist

:memo: A sort-of-static site generator optimized for living documentation of software projects

Home Page:http://palantir.github.io/documentalist

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

documentationdocumentation-tooldocumentation-generatorocto-correct-managed

Documentalist CircleCI

npm npm

A sort-of-static site generator optimized for living documentation of software projects.

Documentation

See the full usage documentation here.

Development

Prerequisites

  • Yarn v1.x
  • Node v18.x

Dev tasks

  • yarn build compiles & builds source code
  • yarn lint lints source code
  • yarn test runs unit test suites
  • yarn deploy pushes docs built in the packages/docs/dist folder to the gh-pages branch

Releases

For maintainers only:

Autorelease

About

:memo: A sort-of-static site generator optimized for living documentation of software projects

http://palantir.github.io/documentalist

documentationdocumentation-tooldocumentation-generatorocto-correct-managed

License:Apache License 2.0

Languages

Language:TypeScript 88.1%Language:JavaScript 7.3%Language:Shell 2.8%Language:CSS 1.7%