Migrate to docsify and Github Pages (#55)

DMOJ · Oct 24, 2019 · f8ea1db · f8ea1db
1 parent 309d776
commit f8ea1db
Show file tree

Hide file tree

Showing 23 changed files with 113 additions and 168 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
 # DMOJ Documentation
 Documentation for the [DMOJ judge](https://github.com/DMOJ/judge) system.
 
-Access at [https://dmoj.readthedocs.org](https://dmoj.readthedocs.org)
+Access at [https://docs.dmoj.ca](https://docs.dmoj.ca)
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,5 @@
 # Table of Contents
 - [**Linux installation**](judge/linux_installation.md)
-- [**Windows installation**](judge/windows_installation.md)
 
 - [**Supported Languages**](judge/supported_languages.md)
 - [**Problem file format**](judge/problem_format.md)

diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,26 @@
+- Site
+  - [Installing the Site](site/installation.md)
+  - [Updating the Site](site/updating.md)
+  - [Contest Formats](site/contest_formats.md)
+  - [Managing Problems Through the Site Interface](site/managing_problems.md)
+  - [PDF Generation of Problem Statements](site/pdf_generation.md)
+  - [LaTeX Math with Wikimedia Mathoid](site/mathoid.md)
+  - [LaTeX Diagrams with Texoid](site/texoid.md)
+  - [reCAPTCHA Spam Registration Prevention](site/recaptcha.md)
+  - [SSL Proxying for User Content](site/ssl_content_proxy.md)
+
+- Judge
+  - [Linux Installation](judge/linux_installation.md)
+  - [Supported Languages](judge/supported_languages.md)
+  - [Colored Compiler Messages](judge/colored_compiler_messages.md)
+  - [Status Codes](judge/status_codes.md)
+
+- Problem File Format
+  - [Problem Format](problem_format/problem_format.md)
+  - [Custom Checkers](problem_format/custom_checkers.md)
+  - [Custom Grader Behaviour](problem_format/custom_graders.md)
+  - [Generators](problem_format/generator.md)
+  - [Problem Examples](problem_format/problem_examples.md)
+
+- About
+ - [License](about/LICENSE.md)
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <meta charset="UTF-8">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      loadSidebar: true,
+      subMaxLevel: 2,
+      name: 'DMOJ Docs'
+    }
+  </script>
+  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-shell-session.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-python.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-latex.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-yaml.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-c.min.js"></script>
+</body>
+</html>
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/judge/colored_compiler_messages.md b/docs/judge/colored_compiler_messages.md
@@ -9,7 +9,7 @@ The DMOJ judge automatically enables colors for newer GCC versions.
 ## Enabling Colors in GCC < 4.9
 Colors can be enabled in GCC versions prior to 4.9 through the `colorgcc` package. If `colorgcc` doesn't work for you, there are alternative packages out there that accomplish a similar result.
 
-```sh
+```shell-session
 sudo apt-get install colorgcc
 ```
 
@@ -18,7 +18,7 @@ Then, specify the `colorgcc` executable in place of the GCC executors in the jud
 ### Using `colorgcc` alongside a GCC 4.9+ installation
 It may be the case that you have multiple GCC versions installed, and that `colorgcc` will attempt to colorize GCC 4.9+ output instead of GCC < 4.9. By default, `colorgcc` uses the GCC executables in `$PATH`, but this behaviour can be overriden through a `.colorgccrc` file placed in the judge `$HOME`. The example below assumes you have an environment variable `$JUDGE_HOME` set to the home directory of the judge user.
 
-```sh
+```shell-session
 echo 'color-g++: /usr/bin/g++' >> $JUDGE_HOME/.colorgccrc
 echo 'color-gcc: /usr/bin/gcc' >> $JUDGE_HOME/.colorgccrc
 echo 'color-c++: /usr/bin/c++' >> $JUDGE_HOME/.colorgccrc

diff --git a/docs/judge/linux_installation.md b/docs/judge/linux_installation.md
@@ -1,8 +1,10 @@
-This installation guide is for Linux based machines (WSL included). For installation on Windows, see the [Windows install instructions](windows_installation).
+# Linux Installation
+
+This installation guide is for Linux based machines (WSL included). Windows is not supported.
 
 ## Installing the prerequisites
 
-```
+```shell-session
 $ apt install git python-dev python-pip build-essential libseccomp-dev
 $ git clone https://github.com/DMOJ/judge
 $ cd judge
@@ -14,7 +16,7 @@ $ python setup.py develop
 
 Start by taking the `runtime` block from the output of the command `dmoj-autoconf` and put it in a new file `config.yml`. Next, add a `problem_storage_root` node where you specify where your problem data is located. 
 
-```
+```yaml
 problem_storage_root:
   - /judge/problems
 runtime:

diff --git a/docs/judge/status_codes.md b/docs/judge/status_codes.md
@@ -1,3 +1,5 @@
+# Status Codes
+
 This page lists all status codes encountered on the DMOJ and their description. It should be noted that it is possible for a test case to be given multiple status codes (indeed, this is usually the case for non-AC verdicts), in which case the one with the highest priority will be displayed. This page lists status codes in order of increasing priority.
 
 ## AC - Accepted

diff --git a/docs/judge/windows_installation.md b/docs/judge/windows_installation.md
diff --git a/docs/problem_format/custom_checkers.md b/docs/problem_format/custom_checkers.md
@@ -1,4 +1,4 @@
-# Checkers - `checker`
+# Custom Checkers
 
 A problem with many possible outputs (e.g. not a single possible answer, with score based on accuracy) may benefit from the `checker` field in the `init.yml` file. A checker is a Python script that is executed per-case post-execution — it grades the output of a process but does not interact with it.
 
@@ -111,7 +111,7 @@ Variables in global scope will exist throughout the grading process.
 Additionally, if the `check` method has the flag `run_on_error` set, it will be run against the submission's output, even if it receives an IR/TLE/RTE/MLE verdict.
 The only built-in checker that has this flag set is the `linecount` checker.
 
-## Returns
+### Returns
 
 `check` can return either a `CheckerResult` object (`from dmoj.result import CheckerResult`), or a boolean (`case_passed_bool`).
  A `CheckerResult` can be instantiated through `CheckerResult(case_passed_bool, points_awarded, feedback='')`.

diff --git a/docs/problem_format/custom_graders.md b/docs/problem_format/custom_graders.md
@@ -1,3 +1,5 @@
+# Custom Graders
+
 # Custom Grader Behaviour - `grader`
 An `init.yml` object can contain a top-level `custom_judge` node, which contains a path to a Python file to be executed as a grader for the problem. The grader has access to the archive specified in `archive`.
 

diff --git a/docs/problem_format/problem_format.md b/docs/problem_format/problem_format.md
@@ -1,3 +1,4 @@
+# Problem Format
 Each problem is stored in its own directory. That directory must contain a file named `init.yml`.
 
 # `init.yml`