Skip to content

Commit 250dd03

Browse files
committed
Push pages for presentation
1 parent ff7a390 commit 250dd03

2 files changed

Lines changed: 35 additions & 2 deletions

File tree

content/misc/documentation_update.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,37 @@
11
+++
22
title='Documentation Update'
33
date=2023-10-27
4-
updated= 2025-05-24
4+
updated= 2025-12-03
55
taxonomies = { tags = ["Misc"] }
66
+++
77

88
# Overview
99

10+
If you are looking for instructions on starting from scratch instead see [my notes](@/misc/site_setup.md) (WIP) on that.
11+
1012
Top level folders under [content](https://github.com/c-git/c-git.github.io/tree/main/content) are sections and each has a
1113
`_index.md` that specifies the configuration parameters for that section.
1214
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>
1319

1420
To ensure that sections stay in alphabetical order we use manually set incrementing weights for each section.
1521
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.
1622
This allows us to keep them in alphabetical order even though sorting by title is not available for top level sections.
1723
We are using [zola](@/misc/zola.md), for more info on how it works see that page.
1824

25+
</details>
26+
1927
# Creating a section
2028

2129
As stated in the [overview](#overview) each section has a `_index.md`.
2230
We only change the first two lines in that file and the other two always stay the same.
2331
Namely, we set:
2432

2533
- `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)
2735

2836
# Creating a page
2937

content/misc/site_setup.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
+++
2+
title='Site Setup Instructions'
3+
date = 2025-12-03
4+
taxonomies = { tags = ["Misc"] }
5+
+++
6+
7+
# Presentation Plan
8+
9+
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)
20+
10. Cost
21+
1. Hosting
22+
2. Tools
23+
3. Domain Registration
24+
4. Support
25+
11. e-Commerce

0 commit comments

Comments
 (0)