Migrate docs to AsciiDoc

ghewgill · Nov 4, 2023 · e98b114 · e98b114
1 parent 918cbef
commit e98b114
Show file tree

Hide file tree

Showing 49 changed files with 6,453 additions and 1,880 deletions.
diff --git a/.gitignore b/.gitignore
@@ -59,3 +59,8 @@ CTestTestfile.cmake
 
 # CMake output for Ninja
 *.ninja
+
+# Antora code
+node_modules/
+# Antora build output
+build/
diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -0,0 +1,18 @@
+site:
+    title: Neon Language
+    start_page: neon-lang::index.adoc
+    url: https://neon-lang.dev
+content:
+    sources:
+    - url: /home/greg/neon-lang
+      start_path: docs
+ui:
+    bundle:
+        url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
+        snapshot: True
+    supplemental_files:
+    - path: partials/header-content.hbs
+      contents: ./supplemental-ui/partials/header-content.hbs
+#antora:
+#    extensions:
+#    - '@antora/lunr-extension' -- requires newer version of nodejs
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore
diff --git a/docs/_templates/.gitignore b/docs/_templates/.gitignore
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -0,0 +1,9 @@
+name: neon-lang
+title: Neon
+version: 0.1
+prerelease: "-alpha"
+start_page: intro.adoc
+nav:
+- modules/ROOT/nav-start.adoc
+- modules/reference/nav.adoc
+- modules/ROOT/nav-end.adoc
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/extensions.rst b/docs/extensions.rst
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/library.rst b/docs/library.rst
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/modules/ROOT/nav-end.adoc b/docs/modules/ROOT/nav-end.adoc
@@ -0,0 +1,3 @@
+* xref:library.adoc[Standard Library]
+* xref:extensions.adoc[Extensions]
+* xref:samples.adoc[Samples]
diff --git a/docs/modules/ROOT/nav-start.adoc b/docs/modules/ROOT/nav-start.adoc
@@ -0,0 +1,4 @@
+* xref:intro.adoc[Introduction]
+* xref:manifesto.adoc[Manifesto]
+* xref:tutorial.adoc[Tutorial]
+* xref:overview.adoc[Overview]
diff --git a/docs/modules/ROOT/pages/extensions.adoc b/docs/modules/ROOT/pages/extensions.adoc
@@ -0,0 +1 @@
+= Extensions
diff --git a/docs/intro.rst → docs/modules/ROOT/pages/intro.adoc b/docs/intro.rst → docs/modules/ROOT/pages/intro.adoc
@@ -1,5 +1,4 @@
-Introduction
-============
+= Introduction
 
 Neon is a high-level, statically typed, garbage collected, imperative programming language intended for teaching and learning the craft of programming.
 Its design borrows features from many popular languages, yet carefully avoids common errors encountered by beginning programmers in other languages.

diff --git a/docs/modules/ROOT/pages/library.adoc b/docs/modules/ROOT/pages/library.adoc
@@ -0,0 +1,3 @@
+= Standard Library
+
+See link:../../../html/[Standard Library].
diff --git a/docs/manifesto.rst → docs/modules/ROOT/pages/manifesto.adoc b/docs/manifesto.rst → docs/modules/ROOT/pages/manifesto.adoc
@@ -1,12 +1,10 @@
-Manifesto
-=========
+= Manifesto
 
 Programming languages today are full of features, and there is a trend toward brevity.
 Brevity is highly expressive, for an expert who understands the notation.
 However, for a new learner or a casual user, brevity promotes unreadable code.
 
-Principles of Design
---------------------
+== Principles of Design
 
 * Prefer keywords over punctuation
 * Good error messages
@@ -16,37 +14,30 @@ Principles of Design
 * Principle of least surprise
 * Easy lookup
 
-Prefer keywords over punctuation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+== Prefer keywords over punctuation
 
 Punctuation is important, but it should be used sparingly.
 
-Good error messages
-^^^^^^^^^^^^^^^^^^^
+== Good error messages
 
 Error messages should explain what is wrong, with suggestions of ways to correct the problem.
 
-Avoid implicit behaviour
-^^^^^^^^^^^^^^^^^^^^^^^^
+== Avoid implicit behaviour
 
 There will be no hidden, implicit, or automatic calls made to code that is not expressly visible in the source.
 
-Explicit declarations
-^^^^^^^^^^^^^^^^^^^^^
+== Explicit declarations
 
 Everything is declared, and identifiers from modules are always qualified.
 
-Single meaning per keyword/operator
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+== Single meaning per keyword/operator
 
 To the greatest reasonable extent, keywords and operators only have one meaning.
 
-Principle of least surprise
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+== Principle of least surprise
 
 This one is hard to quantify, but it's good.
 
-Easy lookup
-^^^^^^^^^^^
+== Easy lookup
 
 By using keywords instead of punctuation, and by using explicit declarations, it is easy to look up unknown things in the documentation.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		= Standard Library

		See link:../../../html/[Standard Library].