You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/misc/documentation_update.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,37 @@
1
1
+++
2
2
title='Documentation Update'
3
3
date=2023-10-27
4
-
updated= 2025-05-24
4
+
updated= 2025-12-03
5
5
taxonomies = { tags = ["Misc"] }
6
6
+++
7
7
8
8
# Overview
9
9
10
+
If you are looking for instructions on starting from scratch instead see [my notes](@/misc/site_setup.md) (WIP) on that.
11
+
10
12
Top level folders under [content](https://github.com/c-git/c-git.github.io/tree/main/content) are sections and each has a
11
13
`_index.md` that specifies the configuration parameters for that section.
12
14
Then inside each folder you will find the pages for that section.
15
+
I also mirror the section names as tag names to work with the [theme](https://github.com/jieiku/abridge/) I currently use.
16
+
17
+
<details>
18
+
<summary>Historic information about how and why I set weights on sections</summary>
13
19
14
20
To ensure that sections stay in alphabetical order we use manually set incrementing weights for each section.
15
21
Initially the gap between the weights of sections is 50 and as sections are added in between we place them centered between their neighbours to reduce the frequency of needing to reweight.
16
22
This allows us to keep them in alphabetical order even though sorting by title is not available for top level sections.
17
23
We are using [zola](@/misc/zola.md), for more info on how it works see that page.
18
24
25
+
</details>
26
+
19
27
# Creating a section
20
28
21
29
As stated in the [overview](#overview) each section has a `_index.md`.
22
30
We only change the first two lines in that file and the other two always stay the same.
23
31
Namely, we set:
24
32
25
33
-`title` to an appropriate string and
26
-
-`weight` we set so that is halfway between the one **before** it and the one **after** it.
34
+
-`weight` we set so that is halfway between the one **before** it and the one **after** it. (Not needed at present but continued as it would be more work to do if needed in the future)
1.[Show live](@demo_page.md) site and [Templates](https://www.getzola.org/themes/)
10
+
2. Briefly describe Static Site Generators (SSG)
11
+
3.[Zola](https://www.getzola.org/)
12
+
4.[Markdown](https://commonmark.org/help/)
13
+
5. Briefly show what controls how github knows how to publish your site ([Github Actions](https://github.com/c-git/c-git.github.io/tree/main/.github/workflows))
14
+
6. Make a corection to this page and push it live
15
+
7. Create sample site
16
+
8. Tooling recommendations / options
17
+
1. In browser only via github (Either limited hours with [codespaces](@/github/codespaces/index.md) or less convenient interface via their website)
18
+
2. Local with vscode and git (which I use)
19
+
9. My additional notes on [markdown](@/misc/markdown.md)
0 commit comments