From f24685debcd02fa6d12ee94d0c7cbc7209efd0b9 Mon Sep 17 00:00:00 2001 From: constantinos Date: Sat, 15 Jul 2023 17:39:16 +0300 Subject: [PATCH] added break/debug !publish! --- content/article/int-break.md | 35 +++++++++++++++++++++++++++ content/issue/int-issue-management.md | 2 +- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 content/article/int-break.md diff --git a/content/article/int-break.md b/content/article/int-break.md new file mode 100644 index 0000000..d7358b1 --- /dev/null +++ b/content/article/int-break.md @@ -0,0 +1,35 @@ +--- +title: "How to break or debug this site 🐛 🧨⚫ " +date: "2023-07-15T17:21:32+03:00" +author: "anybody" +contributors: ["constantinos-miltiadis.md"] +draft: false +keywords: + - draft + - internal + - guide + - debug +abstract: | + Common reasons why the site breaks and would not compile, either locally or on the server. +--- + + +# Break locally & online version + +- `print` items that point to to inexistent files (e.g. a print item with field `print: "article/inexistent-file.md" `) will break the site, and will now allow to compile. This can occur when a target file was renamed, or when a file was converted to draft. Debug that by removing all files of the print directory (except `_index.md`) +- **mixing draft and non draft items** in collections (e.g. issue that `has_artices: ["article/draft.md", "article/non-draft.md"`). Debug: double check that all children of a non-draft item are also non-draft. +- Messing up the header (front matter) of a markdown file: + ``` + --- + title: "How to break this site ⚫ " + date: "2023-07-15T17:21:32+03:00" + author: "anybody" <-- forgetting to close any string quote will break + contributors: ["jane-contributor.md"] <--forgetting to close any array brackets will break + draft: true + keywords: + - draft <-- not following this syntax/indent will break + abstract: | + The text of your abstract. <-- not following this syntax/indent will break + --- <-- removing one or more dashes will break + + ``` \ No newline at end of file diff --git a/content/issue/int-issue-management.md b/content/issue/int-issue-management.md index 6379535..09044a1 100644 --- a/content/issue/int-issue-management.md +++ b/content/issue/int-issue-management.md @@ -3,7 +3,7 @@ title: "Project management (this will be internal) ☸" date: "2023-06-24T16:05:06+03:00" author: "anybody" draft: false -has_articles: ["int-sandpoints.md","int-management.md","int-library.md","int-conventions.md","int-content.md","int-features.md","int-todo.md"] +has_articles: ["int-sandpoints.md","int-management.md","int-library.md","int-conventions.md","int-content.md","int-break.md", "int-features.md","int-todo.md"] keywords: - internal abstract: |