https://github.com/totaltechgeek/doczen
Bundle & validate documentation within your codebase
https://github.com/totaltechgeek/doczen
confluence markdown
Last synced: about 2 months ago
JSON representation
Bundle & validate documentation within your codebase
- Host: GitHub
- URL: https://github.com/totaltechgeek/doczen
- Owner: TotalTechGeek
- Created: 2022-06-14T14:21:33.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-20T17:28:07.000Z (about 4 years ago)
- Last Synced: 2025-03-22T15:02:17.855Z (over 1 year ago)
- Topics: confluence, markdown
- Language: JavaScript
- Homepage:
- Size: 60.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Doczen
A tool to supercharge your documentation.
Doczen is a tool that'll fetch documentation from your projects for bundling, validation, and exporting to other systems, like Confluence.
### What this project is / is not
Doczen is best used as a tool to enhance your documentation & configuration pipelines, making it easier to aggregate & filter those items for export or validation.
However, because there are many excellent solutions out there (Docusaurus, GitBook, Hugo, and many more), Doczen will not attempt to build websites natively.
Instead, we encourage you to use Doczen to feed those tools, and in the near future guides will be added to show an example pipeline that does so.
## CLI Usage
```txt
$ doczen -h confluence -h current -h copy
Version: 0.0.5
Main: A tool designed to super-charge your code-base's documentation.
-i, --input Glob of files to parse. (You may use multiple -i flags)
-p, --prefix Prefix to add to all titles.
-x, --export A module used by doczen, executed left to right.
-h, --help Gets help for the specified module.
-t Uses an exported "transform" function to preprocess documentation before it is used.
--exclude Glob of files to ignore. (You may use multiple --exclude flags)
Confluence: Exports a collection of markdown files to Confluence.
-s, --space The space key to export to
-u, --url The url of the confluence instance
Current: Validates that the documentation is up to date by checking the files that it references.
No command line options.
In the header of your documentation, you may specify a "files" property, which is an array of globs. Ex.
files: ["*.tsx"]
Copy: Exports the documentation / configuration files to a specified folder.
Usually to use with a build stage in a pipeline.
--to The folder to export to.
--extension The extension to use for the files. (default: md)
--plain Do not export the header information.
Remember that you can use a "-t" flag to preprocess the files before they are exported,
this is useful if you need to inject additional metadata.
```
### Examples
```txt
---
title: Our Cool Component API
files: ["*.tsx"]
---
# Our Cool Component API
...
```
```bash
# Validate that the documentation is newer than the code it describes (uses the "files" annotation)
doczen -i "src/**/*.md" -x current
```
``` bash
# Export the documentation to Confluence
doczen -i "src/**/*.md" -x confluence -u doczen -s DOC
```