https://github.com/apostolique/apos-docs

Documentation static site generator.
https://github.com/apostolique/apos-docs

apos docs documentation documentation-generator static-site-generator

Last synced: 4 months ago
JSON representation

Documentation static site generator.

• Host: GitHub
• URL: https://github.com/apostolique/apos-docs
• Owner: Apostolique
• License: mit
• Created: 2020-06-20T21:26:57.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-12-21T20:04:50.000Z (over 1 year ago)
• Last Synced: 2025-03-01T17:49:03.698Z (4 months ago)
• Topics: apos, docs, documentation, documentation-generator, static-site-generator
• Language: JavaScript
• Homepage: https://apostolique.github.io/apos-docs/
• Size: 608 KB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# apos-docs

Documentation static site generator built with Eleventy.

It should work out of the box with minimal configuration. This is meant to be used in combination with GitHub Pages. The final output should work with JavaScript disabled.

[![npm](https://img.shields.io/npm/v/apos-docs.svg)](https://www.npmjs.com/package/apos-docs) [![NuGet](https://img.shields.io/npm/dt/apos-docs.svg)](https://www.npmjs.com/package/apos-docs)

## Description

Takes in a `docs` directory along with your main `README.md`. Compiles the output into an `apos-docs/_site` directory. Adds the content of the `apos-docs/_site` directory to a `gh-pages` branch. The documentation for your repository will be available at `[username].github.io/[repository name]`.

## Documentation

* [Getting started](https://apostolique.github.io/apos-docs/getting-started/)

* [Design choices](https://apostolique.github.io/apos-docs/design-choices/)

* [Markdown showcase](https://apostolique.github.io/apos-docs/markdown/)

## Tech Stack

* [node](https://nodejs.org)

* [eleventy](https://www.11ty.dev/)

* [markdown-it](https://github.com/markdown-it/markdown-it)

* [prism](https://github.com/PrismJS/prism)

* [tailwindcss](https://tailwindcss.com/)

## Used by

* 

* 

* 

*