Docs: extract API reference to separate nav item

ia-toki · Nov 10, 2024 · c076835 · c076835
1 parent f02632c
commit c076835
Show file tree

Hide file tree

Showing 45 changed files with 77 additions and 85 deletions.
diff --git a/web/docs/03-topic-guides/_category_.yml b/web/docs/03-topic-guides/_category_.yml
diff --git a/web/docs/05-api/_category_.yml b/web/docs/05-api/_category_.yml
diff --git a/web/docs/06-release-notes/_category_.yml b/web/docs/06-release-notes/_category_.yml
diff --git a/web/docs/api/00-introduction.md b/web/docs/api/00-introduction.md
@@ -0,0 +1,7 @@
+---
+slug: /api
+---
+
+# Introduction
+
+Welcome to TCFrame API reference.
diff --git a/web/docs/05-api/01-problem-spec.md → web/docs/api/01-problem-spec.md b/web/docs/05-api/01-problem-spec.md → web/docs/api/01-problem-spec.md
diff --git a/web/docs/05-api/02-test-spec.md → web/docs/api/02-test-spec.md b/web/docs/05-api/02-test-spec.md → web/docs/api/02-test-spec.md
diff --git a/web/docs/05-api/03-rnd.md → web/docs/api/03-rnd.md b/web/docs/05-api/03-rnd.md → web/docs/api/03-rnd.md
diff --git a/web/docs/05-api/04-runner.md → web/docs/api/04-runner.md b/web/docs/05-api/04-runner.md → web/docs/api/04-runner.md
diff --git a/web/docs/02-getting-started.md → web/docs/getting-started.md b/web/docs/02-getting-started.md → web/docs/getting-started.md
diff --git a/web/docs/01-introduction.md → web/docs/introduction.md b/web/docs/01-introduction.md → web/docs/introduction.md
diff --git a/web/docs/06-release-notes/0_1_0.md → web/docs/release-notes/0_1_0.md b/web/docs/06-release-notes/0_1_0.md → web/docs/release-notes/0_1_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -10
----
-
 # 0.1.0
 
 February 8, 2015

diff --git a/web/docs/06-release-notes/0_2_0.md → web/docs/release-notes/0_2_0.md b/web/docs/06-release-notes/0_2_0.md → web/docs/release-notes/0_2_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -20
----
-
 # 0.2.0
 
 March 13, 2015

diff --git a/web/docs/06-release-notes/0_3_0.md → web/docs/release-notes/0_3_0.md b/web/docs/06-release-notes/0_3_0.md → web/docs/release-notes/0_3_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -30
----
-
 # 0.3.0
 
 March 29, 2015

diff --git a/web/docs/06-release-notes/0_4_0.md → web/docs/release-notes/0_4_0.md b/web/docs/06-release-notes/0_4_0.md → web/docs/release-notes/0_4_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -40
----
-
 # 0.4.0
 
 June 28, 2015

diff --git a/web/docs/06-release-notes/0_5_0.md → web/docs/release-notes/0_5_0.md b/web/docs/06-release-notes/0_5_0.md → web/docs/release-notes/0_5_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -50
----
-
 # 0.5.0
 
 August 4, 2015

diff --git a/web/docs/06-release-notes/0_6_0.md → web/docs/release-notes/0_6_0.md b/web/docs/06-release-notes/0_6_0.md → web/docs/release-notes/0_6_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -60
----
-
 # 0.6.0
 
 February 8, 2016

diff --git a/web/docs/06-release-notes/0_7_0.md → web/docs/release-notes/0_7_0.md b/web/docs/06-release-notes/0_7_0.md → web/docs/release-notes/0_7_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -70
----
-
 # 0.7.0
 
 March 9, 2016

diff --git a/web/docs/06-release-notes/1_0_0.md → web/docs/release-notes/1_0_0.md b/web/docs/06-release-notes/1_0_0.md → web/docs/release-notes/1_0_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -100
----
-
 # 1.0.0
 
 November 27, 2016

diff --git a/web/docs/06-release-notes/1_0_1.md → web/docs/release-notes/1_0_1.md b/web/docs/06-release-notes/1_0_1.md → web/docs/release-notes/1_0_1.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -101
----
-
 # 1.0.1
 
 November 28, 2016

diff --git a/web/docs/06-release-notes/1_1_0.md → web/docs/release-notes/1_1_0.md b/web/docs/06-release-notes/1_1_0.md → web/docs/release-notes/1_1_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -110
----
-
 # 1.1.0
 
 December 4, 2016

diff --git a/web/docs/06-release-notes/1_2_0.md → web/docs/release-notes/1_2_0.md b/web/docs/06-release-notes/1_2_0.md → web/docs/release-notes/1_2_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -120
----
-
 # 1.2.0
 
 December 16, 2016

diff --git a/web/docs/06-release-notes/1_2_1.md → web/docs/release-notes/1_2_1.md b/web/docs/06-release-notes/1_2_1.md → web/docs/release-notes/1_2_1.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -121
----
-
 # 1.2.1
 
 January 29, 2017

diff --git a/web/docs/06-release-notes/1_3_0.md → web/docs/release-notes/1_3_0.md b/web/docs/06-release-notes/1_3_0.md → web/docs/release-notes/1_3_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -130
----
-
 # 1.3.0
 
 February 10, 2017

diff --git a/web/docs/06-release-notes/1_4_0.md → web/docs/release-notes/1_4_0.md b/web/docs/06-release-notes/1_4_0.md → web/docs/release-notes/1_4_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -140
----
-
 # 1.4.0
 
 May 29, 2017

diff --git a/web/docs/06-release-notes/1_5_0.md → web/docs/release-notes/1_5_0.md b/web/docs/06-release-notes/1_5_0.md → web/docs/release-notes/1_5_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -150
----
-
 # 1.5.0
 
 July 16, 2017

diff --git a/web/docs/06-release-notes/1_6_0.md → web/docs/release-notes/1_6_0.md b/web/docs/06-release-notes/1_6_0.md → web/docs/release-notes/1_6_0.md
@@ -1,7 +1,3 @@
----
-sidebar_position: -160
----
-
 # 1.6.0
 
 September 17, 2017

diff --git a/...ocs/03-topic-guides/01-problem-package.md → web/docs/topic-guides/01-problem-package.md b/...ocs/03-topic-guides/01-problem-package.md → web/docs/topic-guides/01-problem-package.md
diff --git a/web/docs/03-topic-guides/02-spec.md → web/docs/topic-guides/02-spec.md b/web/docs/03-topic-guides/02-spec.md → web/docs/topic-guides/02-spec.md
diff --git a/web/docs/03-topic-guides/03-io-variables.md → web/docs/topic-guides/03-io-variables.md b/web/docs/03-topic-guides/03-io-variables.md → web/docs/topic-guides/03-io-variables.md
diff --git a/web/docs/03-topic-guides/04-io-formats.md → web/docs/topic-guides/04-io-formats.md b/web/docs/03-topic-guides/04-io-formats.md → web/docs/topic-guides/04-io-formats.md
diff --git a/web/docs/03-topic-guides/05-styles.md → web/docs/topic-guides/05-styles.md b/web/docs/03-topic-guides/05-styles.md → web/docs/topic-guides/05-styles.md
diff --git a/web/docs/03-topic-guides/06-constraints.md → web/docs/topic-guides/06-constraints.md b/web/docs/03-topic-guides/06-constraints.md → web/docs/topic-guides/06-constraints.md
diff --git a/web/docs/03-topic-guides/07-subtasks.md → web/docs/topic-guides/07-subtasks.md b/web/docs/03-topic-guides/07-subtasks.md → web/docs/topic-guides/07-subtasks.md
diff --git a/web/docs/03-topic-guides/08-test-cases.md → web/docs/topic-guides/08-test-cases.md b/web/docs/03-topic-guides/08-test-cases.md → web/docs/topic-guides/08-test-cases.md
diff --git a/web/docs/03-topic-guides/09-test-groups.md → web/docs/topic-guides/09-test-groups.md b/web/docs/03-topic-guides/09-test-groups.md → web/docs/topic-guides/09-test-groups.md
diff --git a/web/docs/03-topic-guides/10-multi-case.md → web/docs/topic-guides/10-multi-case.md b/web/docs/03-topic-guides/10-multi-case.md → web/docs/topic-guides/10-multi-case.md
diff --git a/web/docs/03-topic-guides/11-grading.md → web/docs/topic-guides/11-grading.md b/web/docs/03-topic-guides/11-grading.md → web/docs/topic-guides/11-grading.md
diff --git a/web/docs/03-topic-guides/venn-diagram.png → web/docs/topic-guides/venn-diagram.png b/web/docs/03-topic-guides/venn-diagram.png → web/docs/topic-guides/venn-diagram.png
diff --git a/web/docs/04-tutorials/01-tutorial-1.md → web/docs/tutorials/01-tutorial-1.md b/web/docs/04-tutorials/01-tutorial-1.md → web/docs/tutorials/01-tutorial-1.md
diff --git a/web/docs/04-tutorials/02-tutorial-2.md → web/docs/tutorials/02-tutorial-2.md b/web/docs/04-tutorials/02-tutorial-2.md → web/docs/tutorials/02-tutorial-2.md
diff --git a/web/docs/04-tutorials/_category_.yml → web/docs/tutorials/_category_.yml b/web/docs/04-tutorials/_category_.yml → web/docs/tutorials/_category_.yml
diff --git a/web/docs/04-tutorials/venn-diagram.png → web/docs/tutorials/venn-diagram.png b/web/docs/04-tutorials/venn-diagram.png → web/docs/tutorials/venn-diagram.png
diff --git a/web/docusaurus.config.js b/web/docusaurus.config.js
@@ -71,6 +71,12 @@ const config = {
             position: 'left',
             label: 'Docs',
           },
+          {
+            type: 'docSidebar',
+            sidebarId: 'apiSidebar',
+            position: 'left',
+            label: 'API',
+          },
           {
             href: 'https://github.com/ia-toki/tcframe',
             label: 'GitHub',

diff --git a/web/sidebars.js b/web/sidebars.js
@@ -13,21 +13,68 @@
 
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
-  // By default, Docusaurus generates a sidebar from the docs folder structure
-  docsSidebar: [{type: 'autogenerated', dirName: '.'}],
-
-  // But you can create a sidebar manually
-  /*
-  tutorialSidebar: [
-    'intro',
-    'hello',
+  docsSidebar: [
+    'introduction',
+    'getting-started',
+    {
+      type: 'category',
+      label: 'Topic Guides',
+      link: {
+        type: 'generated-index',
+        slug: '/topic-guides',
+        description: 'In this guide, we will learn each aspect of TCFrame more thoroughly. Each section may have notes at the end, explaining the current limitations and future plans of the corresponding aspect.',
+      },
+      items: [
+        'topic-guides/problem-package',
+        'topic-guides/spec',
+        'topic-guides/io-variables',
+        'topic-guides/io-formats',
+        'topic-guides/styles',
+        'topic-guides/constraints',
+        'topic-guides/subtasks',
+        'topic-guides/test-cases',
+        'topic-guides/test-groups',
+        'topic-guides/multi-case',
+        'topic-guides/grading',
+      ],
+    },
+    {
+      type: 'category',
+      label: 'Tutorials',
+      link: {
+        type: 'generated-index',
+        slug: '/tutorials',
+        description: 'Here, you can find case studies and best practices on how to write your spec files. It is expected that you have already read the getting started guide before reading through the tutorials.',
+      },
+      items: [
+        'tutorials/tutorial-1',
+        'tutorials/tutorial-2',
+      ]
+    },
     {
       type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
+      label: 'Release Notes',
+      items: [
+        'release-notes/1_6_0',
+        'release-notes/1_5_0',
+        'release-notes/1_4_0',
+        'release-notes/1_3_0',
+        'release-notes/1_2_1',
+        'release-notes/1_2_0',
+        'release-notes/1_1_0',
+        'release-notes/1_0_1',
+        'release-notes/1_0_0',
+        'release-notes/0_7_0',
+        'release-notes/0_6_0',
+        'release-notes/0_5_0',
+        'release-notes/0_4_0',
+        'release-notes/0_3_0',
+        'release-notes/0_2_0',
+        'release-notes/0_1_0',
+      ]
     },
   ],
-   */
+  apiSidebar: [{type: 'autogenerated', dirName: 'api'}],
 };
 
 export default sidebars;
diff --git a/web/src/css/custom.css b/web/src/css/custom.css
@@ -15,6 +15,7 @@
   --ifm-color-primary-lightest: #3cad6e;
   --ifm-code-font-size: 14px;
   --ifm-link-color: #3b73b9;
+  --ifm-navbar-link-hover-color: #3b73b9;
   --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
 }
 
@@ -63,3 +64,8 @@ li > p:has(strong) {
     margin-top: 6px !important;
   }
 }
+
+.navbar__link--active {
+  background-color: var(--ifm-menu-color-background-active);
+  border-radius: .25rem;
+}