A complete and comprehensive guide to using the Interactive CYOA Creator by MeanDelay.
View it live at one of these links:
interactive-cyoa-creator
, but you have to memorize my username as
well.To contribute to this, simply fork this repository, make your changes, and open a pull request.
See CONTRIBUTING.md for specifics.
You may need to set up a virtual environment if you're deploying on your own machine due to conflicts of dependencies:
python -m venv venv/
# If you're on an externally managed drive on Linux, do the below command
# $ mkdir ~/tmp
# $ python -m venv ~/tmp/icct-venv/
./venv/Scripts/activate
# $ sudo chmod +x ~/tmp/icct-venv/bin/activate
# $ ~/tmp/icct-venv/bin/activate
Leverage requirements.txt
:
pip install -r ./requirements.txt
# ~/tmp/icct-venv/bin/pip install -r ./requirements.txt
This may take a while for the first time.
Install the latest mkdocs-material beta release:
git clone --depth 1 -b 9.2.0b1 https://github.com/squidfunk/mkdocs-material/
pip install --force -e ./mkdocs-material/
Install the plugins:
pip install mkdocs-minify-plugin mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin
If you cloned the repository, you're all set!
Run:
mkdocs serve
to serve it (with changes being automatically applied), ormkdocs build
to build a static version which can be run without serving
each time and without mkdocs.If you didn't use git clone
, and instead downloaded the source from the
Releases page, then you'll need to initiate a Git repository:
# change for whatever version you downloaded
cd interactive-cyoa-tutorial-0.1.0/
git init; git add .; git commit -m "Initial commit"
mkdocs serve # serve
mkdocs build # or build
deactivate