https://github.com/palantir/documentalist

:memo: A sort-of-static site generator optimized for living documentation of software projects
https://github.com/palantir/documentalist

documentation documentation-generator documentation-tool octo-correct-managed

Last synced: 15 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/palantir/documentalist
• Owner: palantir
• License: apache-2.0
• Created: 2017-02-23T21:47:47.000Z (about 8 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-13T01:26:57.000Z (about 1 year ago)
• Last Synced: 2024-04-14T09:05:04.791Z (about 1 year ago)
• Topics: documentation, documentation-generator, documentation-tool, octo-correct-managed
• Language: TypeScript
• Homepage: http://palantir.github.io/documentalist
• Size: 1.64 MB
• Stars: 145
• Watchers: 238
• Forks: 27
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - palantir/documentalist - :memo: A sort-of-static site generator optimized for living documentation of software projects (TypeScript)

README

        
# Documentalist [![CircleCI](https://circleci.com/gh/palantir/documentalist/tree/develop.svg?style=svg)](https://circleci.com/gh/palantir/workflows/documentalist)

[![npm](https://img.shields.io/npm/v/@documentalist/compiler.svg?label=@documentalist/compiler)](https://www.npmjs.com/package/@documentalist/compiler)

[![npm](https://img.shields.io/npm/v/@documentalist/client.svg?label=@documentalist/client)](https://www.npmjs.com/package/@documentalist/client)

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

### Documentation

[See the full usage documentation here](https://palantir.github.io/documentalist/).

### 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](https://img.shields.io/badge/Perform%20an-Autorelease-success.svg)](https://autorelease.general.dmz.palantir.tech/palantir/documentalist)