Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

init-docs #100

Merged
merged 3 commits into from
Dec 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@ out.rbxl
# Wally
wally.lock
Packages

# MKDocs
site/
4 changes: 2 additions & 2 deletions build/data.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.4.1",
"version": "0.5.0",
"stage": "pre-alpha",
"testing": "no"
"testing": "yes"
}
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Introduction

This is the documentation for the project.

Written in [Markdown](http://daringfireball.net/projects/markdown/)
and built with [MkDocs](https://www.mkdocs.org/).
deployed to [Vercel](https://vercel.com/).
7 changes: 7 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
site_name: Documentation

repo_url: https://github.com/reimakesgames/hybrid-conflict
repo_name: GitHub


theme: readthedocs
9 changes: 9 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "mkdocs",
"version": "1.0.0",
"private": true,
"scripts": {
"dev": "mkdocs serve",
"build": "mkdocs build -d public"
}
}
4 changes: 4 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
mkdocs
#Add pip package if needed
#mkdocs-bootswatch
#mkdocs-minify-plugin