hans
/
ad_pubfiles
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: add a few placeholders, improve prerequisites section.

This commit is contained in:
Hans Fast 2026-03-25 16:14:28 +01:00
parent 767042e86c
commit 7a804c0204
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -11,7 +11,7 @@ How I create web pages from selected files from this repository, with private an
## Quickstart
Prerequisites: [node](https://nodejs.org); [git](https://git-scm.com); clone this repository with `git clone https://git.surfacemarkup.net/hans/ad_pubfiles`.
Prerequisites: install [node](https://nodejs.org) and [git](https://git-scm.com); clone [the source](https://git.surfacemarkup.net/hans/ad_pubfiles) with `git clone https://git.surfacemarkup.net/hans/ad_pubfiles`.
0. In this repository, `npm install` dependencies, including [Web Origami](https://weborigami.org). The following instructions assume you also have installed the `ori` command with `npm install -g @weborigami/origami`. If not, replace `ori` in commands below with `npx @weborigami/origami`.
@ -54,23 +54,25 @@ I have developed a text markup format which suits my needs better than Markdown.
<trl-alt lang="nl">
## Markup-taal
Ik heb een formaat ontwikkeld voor tekst die beter bij mijn doelen past dan Markdown.
Ik heb een formaat ontwikkeld voor tekst die beter bij mijn doelen past dan Markdown. Het werkt, en ik kan er HTML mee genereren, maar er is nog een heleboel dat het nog niet kan. Omdat de laatste 10% altijd het meeste werk is, gebruik ik voor nu Markdown.
</trl-alt>
</trl-group>
## Changes and Updates
This section SHALL describe the idea behind the [Changelog](/changelog).
<p>—private-below—</p>
EXCEPT NOT REALLY! In this case, because this file is hardlinked to `README.md` inside a publicised git repository. You have been warned!
## Internal Links
![link to image](/ad_pubfiles_pub.d/images/bird.webp)
![test link to image](/ad_pubfiles_pub.d/images/bird.webp)
Internal links need to be absolute from the root of the directory. This SHOULD be fixed in a future version.
## Web Origami, Public and Private Site Versions
I want to make only select files public. Files whose name contains the tag `pub` should be included in the public build. The public build should be the default. To include all files, pass 'all' to the site.ori file. That sort of reduces the risk of accidentally publishing private files.