This is the repository for the official documentation and knowledge base for the CTFd ecosystem of services and tools. It can be viewed online at https://docs.ctfd.io/.
To contribute new changes/fixes to the docs, fork the repo, make your changes in a branch, and create an pull request against this repo.
The docs are developed using hugo with the docsy theme. These install instructions are written for OSX as a majority of development occurs there.
Javascript dependencies are managed with yarn.
brew install hugo
git clone --recurse-submodules --depth 1 [email protected]:CTFd/docs.git
yarn install
hugo server
open http://localhost:1313/
The documentation is automatically built and deployed to https://docs.ctfd.io/ after being merged to master.