search

SpecterOps / Nemesis

An offensive data enrichment pipeline
https://specterops.github.io/Nemesis/
Other
597 stars 59 forks source link

Add documentation hosting on Github pages #56

Closed MEhrn00 closed 5 months ago

MEhrn00 commented 5 months ago

This PR will create a Github pages site hosting the Nemesis documentation. The documentation is built with MkDocs using the Material theme.

Documentation will be automatically built and redeployed when changes to the documentation files are pushed to the main branch.

Documentation + Helm Charts

The documentation Github pages site is designed to co-exist with the Nemesis Helm charts. The Helm repository index file and the documentation are merged together.

Notes about MkDocs and Material

The Material theme allows for a lot of customization. Things such as the content layout and titles of pages can be changed. The MkDocs user guide and the Material reference page have information on how to configure the site pages.

Example

This currently being hosted on my fork at https://mehrn00.github.io/Nemesis

t94j0 commented 5 months ago

Did a few updates after merging the traefik branch. This is awesome!