https://github.com/moddedtechnic/documentation_portal

A portal to access static documents from markdown and typst.
https://github.com/moddedtechnic/documentation_portal

documentation hugo static-site typst

Last synced: 3 months ago
JSON representation

A portal to access static documents from markdown and typst.

• Host: GitHub
• URL: https://github.com/moddedtechnic/documentation_portal
• Owner: moddedTechnic
• License: mpl-2.0
• Created: 2024-07-21T22:25:11.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-28T10:35:10.000Z (almost 2 years ago)
• Last Synced: 2025-01-31T00:42:40.464Z (over 1 year ago)
• Topics: documentation, hugo, static-site, typst
• Language: CSS
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Documentation Portal

A modern portal for legal and administrative documentation.

Managed via git. Built on Hugo and Typst.

**Note**: This portal should not be used for sensitive documentation on the public internet. **NO** authentication is provided.

## Usage

On [GitHub](https://github.com/moddedTechnic/documentation_portal), click the green "Use this template" button to create a new repository based on this one.

Clone your new repository to your local machine.

Install [Hugo](https://gohugo.io/getting-started/installing/).

Add your documentation to the `docs` directory.

Build with `python3 build.py`.

This will build a static site in the `public` directory, which you can serve with any static site server or deploy to a service like Cloudflare Pages.