kekskurse/wikipress
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Readme
All checks were successful
ci/woodpecker/push/commit Pipeline was successful
Details

Browse source
This commit is contained in:
kekskurse 2025-07-06 17:23:35 +02:00
parent db1c7eacc5
commit 963b9fa708
1 changed files with 32 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
Readme.md
View file

@ -1,2 +1,32 @@
URL:
https://wikipress.s3.fr-par.scw.cloud/wikipress/wikipress/wikipress
# Wikipress
Create a wiki like static html page base on markdown files, if the content is a git repro it also show the history.
# Install
Get the last Version and make it executable
```
wget https://wikipress.s3.fr-par.scw.cloud/wikipress/wikipress/wikipress
chmod u+x wikipress
```
# Content
Create a foldern with the content of the page, e.g. `/home/foo/mywikipage` and add some MArkedown files. The markdown file contains spme header information in a `key: value` format, than a seperator `---` and than the markdown content. For an example the content of a file look like this:
```
title: Startseite
order: 10
---
## Links
* [kekskurse.de](https://kekskurse.de/)
```
# Generate HTML Page
To generate a HTML Page out of the content you can run wikipress with the `--path` parameter, if the content is not a git repro you also need to add the `--no-git` flag.
```
./wikipress --path /home/foo/mywikipage --no-git
```
# Example
* [wiki.kekskurse.de](https://wiki.kekskurse.de)