Use .dj canonically instead of .djot (fix #17)

irskep · Aug 27, 2024 · a112bc4 · a112bc4
1 parent bf12300
commit a112bc4
Show file tree

Hide file tree

Showing 40 changed files with 41 additions and 97 deletions.
diff --git a/docs/src/basics/configuration.djot → docs/src/basics/configuration.dj b/docs/src/basics/configuration.djot → docs/src/basics/configuration.dj
diff --git a/docs/src/basics/deploying.djot → docs/src/basics/deploying.dj b/docs/src/basics/deploying.djot → docs/src/basics/deploying.dj
diff --git a/docs/src/basics/djockey_command.djot → docs/src/basics/djockey_command.dj b/docs/src/basics/djockey_command.djot → docs/src/basics/djockey_command.dj
diff --git a/docs/src/basics/djot.djot → docs/src/basics/djot.dj b/docs/src/basics/djot.djot → docs/src/basics/djot.dj
diff --git a/docs/src/basics/frontmatter.djot → docs/src/basics/frontmatter.dj b/docs/src/basics/frontmatter.djot → docs/src/basics/frontmatter.dj
diff --git a/docs/src/basics/index.djot → docs/src/basics/index.dj b/docs/src/basics/index.djot → docs/src/basics/index.dj
diff --git a/docs/src/basics/linking.djot → docs/src/basics/linking.dj b/docs/src/basics/linking.djot → docs/src/basics/linking.dj
@@ -4,7 +4,7 @@ Everything you can do in Markdown, you can also do in Djockey. If you find that
 
 ## Extension or no extension, up to you
 
-If you have a doc at `life.djot`, you can link to it with either `[link text](life.djot)` or just `[link text](life)`.
+If you have a doc at `life.dj`, you can link to it with either `[link text](life.dj)` or just `[link text](life)`.
 
 ## Static files
 
@@ -15,16 +15,16 @@ You can link to static files using relative paths, or absolute paths where the r
 Let's say you wrote some text you need to refer to in many places across your docs, and gave it a custom identifier:
 
 ```djot
-{% in /reference/answers/big-questions/life.djot %}
+{% in /reference/answers/big-questions/life.dj %}
 {#the-answer}
 # The answer to life, the universe, and everything
 
 It's 42.
 ```
 
-In any other documentation system, you'd need to link to `/reference/answers/big-questions/life#the-answer`{.language-sh}, or use a relative URL like `../../answers/big-questions/life#the-answer`{.language-sh}. But if you move `life.djot`{.language-sh} to another directory, you need to find all those links and update them.
+In any other documentation system, you'd need to link to `/reference/answers/big-questions/life#the-answer`{.language-sh}, or use a relative URL like `../../answers/big-questions/life#the-answer`{.language-sh}. But if you move `life.dj`{.language-sh} to another directory, you need to find all those links and update them.
 
-With Djockey, you can link to it anywhere with just `#the-answer`{.language-css}, and Djockey will figure out which doc it lives in. If there are two files containing a heading `#the-answer`{.language-css}, you can use just enough of the path to disambiguate the two, like `life#the-answer`{.language-sh} or `answers/big-questions/life.djot#the-answer`{.language-sh}.
+With Djockey, you can link to it anywhere with just `#the-answer`{.language-css}, and Djockey will figure out which doc it lives in. If there are two files containing a heading `#the-answer`{.language-css}, you can use just enough of the path to disambiguate the two, like `life#the-answer`{.language-sh} or `answers/big-questions/life.dj#the-answer`{.language-sh}.
 
 The goal of this feature is to make it easier to reorganize your docs on the fly. If there's any ambiguity, Djockey will warn you at build time.
 

diff --git a/docs/src/basics/markup_demo.djot → docs/src/basics/markup_demo.dj b/docs/src/basics/markup_demo.djot → docs/src/basics/markup_demo.dj
diff --git a/docs/src/basics/sections.dj b/docs/src/basics/sections.dj
@@ -0,0 +1,12 @@
+---
+order: 2
+---
+# Sections
+
+Djockey uses the directory tree to group documents into sections and subsections.
+
+## `index.dj`
+
+Put an `index.dj` (or `index.md`) file in any directory to customize its metadata (`title`, `order`) and give the beginning of the section some content.
+
+If `index.dj` contains front matter but no content, then the section will use the front matter, but no page will be rendered. As an example, see the "Plugins" vs "Writing with Djockey" sections on this site.
diff --git a/docs/src/basics/sections.djot b/docs/src/basics/sections.djot
diff --git a/docs/src/basics/static_files.djot → docs/src/basics/static_files.dj b/docs/src/basics/static_files.djot → docs/src/basics/static_files.dj
diff --git a/...rc/contributing/building_and_running.djot → .../src/contributing/building_and_running.dj b/...rc/contributing/building_and_running.djot → .../src/contributing/building_and_running.dj
diff --git a/docs/src/contributing/client_side_js.djot → docs/src/contributing/client_side_js.dj b/docs/src/contributing/client_side_js.djot → docs/src/contributing/client_side_js.dj
diff --git a/docs/src/contributing/dependencies.djot → docs/src/contributing/dependencies.dj b/docs/src/contributing/dependencies.djot → docs/src/contributing/dependencies.dj
diff --git a/docs/src/contributing/index.djot → docs/src/contributing/index.dj b/docs/src/contributing/index.djot → docs/src/contributing/index.dj
diff --git a/docs/src/features/index.djot → docs/src/features/index.dj b/docs/src/features/index.djot → docs/src/features/index.dj
diff --git a/docs/src/features/mermaid_diagrams.djot → docs/src/features/mermaid_diagrams.dj b/docs/src/features/mermaid_diagrams.djot → docs/src/features/mermaid_diagrams.dj
diff --git a/docs/src/features/syntax_highlighting.djot → docs/src/features/syntax_highlighting.dj b/docs/src/features/syntax_highlighting.djot → docs/src/features/syntax_highlighting.dj
diff --git a/docs/src/getting_started.djot → docs/src/getting_started.dj b/docs/src/getting_started.djot → docs/src/getting_started.dj
diff --git a/docs/src/index.djot → docs/src/index.dj b/docs/src/index.djot → docs/src/index.dj
diff --git a/docs/src/installation.djot → docs/src/installation.dj b/docs/src/installation.djot → docs/src/installation.dj
diff --git a/docs/src/plugins/index.djot → docs/src/plugins/index.dj b/docs/src/plugins/index.djot → docs/src/plugins/index.dj
diff --git a/docs/src/plugins/plugin_api.djot → docs/src/plugins/plugin_api.dj b/docs/src/plugins/plugin_api.djot → docs/src/plugins/plugin_api.dj
diff --git a/docs/src/plugins/using_plugins.djot → docs/src/plugins/using_plugins.dj b/docs/src/plugins/using_plugins.djot → docs/src/plugins/using_plugins.dj
diff --git a/docs/src/why.djot → docs/src/why.dj b/docs/src/why.djot → docs/src/why.dj
diff --git a/examples/frontmatter.djot b/examples/frontmatter.djot
diff --git a/examples/full/.gitignore b/examples/full/.gitignore
diff --git a/examples/full/djockey.yaml b/examples/full/djockey.yaml
diff --git a/examples/full/docs/crispy.djot b/examples/full/docs/crispy.djot
diff --git a/examples/full/docs/image.png b/examples/full/docs/image.png
diff --git a/examples/full/docs/index.md b/examples/full/docs/index.md
diff --git a/examples/full/docs/layer/inner.djot b/examples/full/docs/layer/inner.djot
diff --git a/examples/full/docs/layer/layer2/index.djot b/examples/full/docs/layer/layer2/index.djot
diff --git a/examples/full/docs/layer/layer2/inner2.djot b/examples/full/docs/layer/layer2/inner2.djot
diff --git a/examples/full/docs/layer/meta.yaml b/examples/full/docs/layer/meta.yaml
diff --git a/examples/full/docs/second.djot b/examples/full/docs/second.djot
diff --git a/examples/full/docs/staticfile.txt b/examples/full/docs/staticfile.txt
diff --git a/src/input/fileExtensions.ts b/src/input/fileExtensions.ts
@@ -3,9 +3,9 @@ import { ALL_INPUT_FORMATS, DjockeyInputFormat } from "../types.js";
 export function getExtensionForInputFormat(fmt: DjockeyInputFormat): string[] {
   switch (fmt) {
     case "gfm":
-      return ["md"];
+      return ["md", "markdown"];
     case "djot":
-      return ["djot"];
+      return ["djot", "dj"];
   }
 }
 

diff --git a/src/plugins/autoTitlePlugin.test.ts b/src/plugins/autoTitlePlugin.test.ts
@@ -21,9 +21,9 @@ test("Title is set to first heading by default", () => {
     },
     title: "Test doc",
     titleAST: [{ tag: "str", text: "Test doc" }],
-    originalExtension: ".djot",
-    absolutePath: "Test Doc.djot",
-    relativePath: "Test Doc.djot",
+    originalExtension: ".dj",
+    absolutePath: "Test Doc.dj",
+    relativePath: "Test Doc.dj",
     filename: "Test Doc",
     frontMatter: {},
     data: {},
@@ -34,7 +34,7 @@ test("Title is set to first heading by default", () => {
     inputDir: ".",
     rootPath: ".",
     outputDir: { html: "./dist/html", gfm: "./dist/gfm" },
-    fileList: ["Test Doc.djot"],
+    fileList: ["Test Doc.dj"],
     urlRoot: "URL_ROOT",
     inputFormats: { djot: true },
   };
@@ -61,9 +61,9 @@ test("Title is set to frontMatter.title if present", () => {
     },
     title: "Test doc",
     titleAST: [{ tag: "str", text: "Test doc" }],
-    originalExtension: ".djot",
-    absolutePath: "Test Doc.djot",
-    relativePath: "Test Doc.djot",
+    originalExtension: ".dj",
+    absolutePath: "Test Doc.dj",
+    relativePath: "Test Doc.dj",
     filename: "Test Doc",
     frontMatter: { title: "Custom title" },
     data: {},
@@ -74,7 +74,7 @@ test("Title is set to frontMatter.title if present", () => {
     inputDir: ".",
     rootPath: ".",
     outputDir: { html: "./dist/html", gfm: "./dist/gfm" },
-    fileList: ["Test Doc.djot"],
+    fileList: ["Test Doc.dj"],
     urlRoot: "URL_ROOT",
   };
   const docSet = new DocSet(config, [new AutoTitlePlugin()], [doc]);

diff --git a/src/plugins/tableOfContentsPlugin.test.ts b/src/plugins/tableOfContentsPlugin.test.ts
@@ -23,9 +23,9 @@ test("Generates TOCEntry tree for one doc", () => {
     },
     title: "Test doc",
     titleAST: [{ tag: "str", text: "Test doc" }],
-    originalExtension: ".djot",
-    absolutePath: "Test Doc.djot",
-    relativePath: "Test Doc.djot",
+    originalExtension: ".dj",
+    absolutePath: "Test Doc.dj",
+    relativePath: "Test Doc.dj",
     filename: "Test Doc",
     frontMatter: {},
     data: {},
@@ -39,18 +39,18 @@ test("Generates TOCEntry tree for one doc", () => {
 
   expect(html).toEqual(`<ul>
 <li>
-<a href="/Test Doc.djot#Heading-1">Heading 1</a>
+<a href="/Test Doc.dj#Heading-1">Heading 1</a>
 <ul>
 <li>
-<a href="/Test Doc.djot#Heading-1-1">Heading 1.1</a>
+<a href="/Test Doc.dj#Heading-1-1">Heading 1.1</a>
 </li>
 </ul>
 </li>
 <li>
-<a href="/Test Doc.djot#Heading-2">Heading 2</a>
+<a href="/Test Doc.dj#Heading-2">Heading 2</a>
 <ul>
 <li>
-<a href="/Test Doc.djot#Heading-2-2">Heading 2.2</a>
+<a href="/Test Doc.dj#Heading-2-2">Heading 2.2</a>
 </li>
 </ul>
 </li>
@@ -75,9 +75,9 @@ test("Works end-to-end with LinkRewritingPlugin", () => {
     },
     title: "Test doc",
     titleAST: [{ tag: "str", text: "Test doc" }],
-    originalExtension: ".djot",
-    absolutePath: "Test Doc.djot",
-    relativePath: "Test Doc.djot",
+    originalExtension: ".dj",
+    absolutePath: "Test Doc.dj",
+    relativePath: "Test Doc.dj",
     filename: "Test Doc",
     frontMatter: {},
     data: {},
@@ -87,7 +87,7 @@ test("Works end-to-end with LinkRewritingPlugin", () => {
     ...getConfigDefaults(),
     inputDir: ".",
     outputDir: { html: "./dist/html", gfm: "./dist/gfm" },
-    fileList: ["Test Doc.djot"],
+    fileList: ["Test Doc.dj"],
     urlRoot: "URL_ROOT",
     inputFormats: { djot: true },
     rootPath: ".",
@@ -106,18 +106,18 @@ test("Works end-to-end with LinkRewritingPlugin", () => {
 
   expect(html).toEqual(`<ul>
 <li>
-<a href="Test Doc.djot.html#Heading-1">Heading 1</a>
+<a href="Test Doc.dj.html#Heading-1">Heading 1</a>
 <ul>
 <li>
-<a href="Test Doc.djot.html#Heading-1-1">Heading 1.1</a>
+<a href="Test Doc.dj.html#Heading-1-1">Heading 1.1</a>
 </li>
 </ul>
 </li>
 <li>
-<a href="Test Doc.djot.html#Heading-2">Heading 2</a>
+<a href="Test Doc.dj.html#Heading-2">Heading 2</a>
 <ul>
 <li>
-<a href="Test Doc.djot.html#Heading-2-2">Heading 2.2</a>
+<a href="Test Doc.dj.html#Heading-2-2">Heading 2.2</a>
 </li>
 </ul>
 </li>