2.1 KiB
author | published | title | description |
---|---|---|---|
~alexlehm | true | Wiki | How to contibute to the ~green wiki |
How to contribute to the ~green wiki
To contribute to the wiki, you need to create or modify pages in markdown format and add them to the wiki git repository
To get started, fork the tilde.green/wiki repo at
https://git.tilde.green/tilde.green/wiki
to your own account
To be able test the changes, you can put the wiki dir directly into the public_html dir
username@tilde:~/public_html$ git clone git@git.tilde.green:username/wiki.git
create the additional files used by the wiki with composer
username@tilde:~/public_html$ cd wiki
username@tilde:~/public_html/wiki$ composer install
create a new file from the template.md file
username@tilde:~/public_html/wiki$ cd pages/
username@tilde:~/public_html/wiki/pages$ cp template.md wiki.md
create a new branch so you don't mess up your master branch
username@tilde:~/public_html/wiki$ git branch wikipage
username@tilde:~/public_html/wiki$ git checkout wikipage
edit the file and add it to the wiki
username@tilde:~/public_html/wiki$ emacs pages/wiki.md
username@tilde:~/public_html/wiki$ git add pages/wiki.md
To preview the wiki, you can go to
https://tilde.green/~username/wiki/
, the links to the individual pages
do not work since a rewrite rule is missing.
You can view the pages by adding ?page= before the page name,
e.g. https://tilde.green/~username/wiki/?page=wiki
Alternatively you can run a test server in your account with
php -S localhost:9000
To access the server from your own browser, you need a ssh tunnel since the pubnix does not allow external port access.
ssh -x -L 9000:localhost:9000 username@tilde.green
Then you can access your wiki instance with http://localhost:9000/
and the local links work directly
If you run a php test server, please don't leave it running as this allocates the local port and nobody else would be able to start a server on the same port.
When you are satisfied with the content, commit and push the repo and create a pull request.