diff options
Diffstat (limited to 'man.sr.ht')
-rw-r--r-- | man.sr.ht/index.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/man.sr.ht/index.md b/man.sr.ht/index.md new file mode 100644 index 0000000..7b89bee --- /dev/null +++ b/man.sr.ht/index.md @@ -0,0 +1,32 @@ +man.sr.ht is a git-powered wiki that can host documentation for your projects. +Click "create wiki" in the top right to get started (you will have to log in +first). + +## Repository structure + +Each repository should be laid out with files and directories you want +to serve in your wiki. Markdown files (`*.md`) will be +compiled to HTML with the same Markdown rules that are [supported on the rest of +the site](/markdown). Each page will be made available at the URL of the path to +the file, except for `index.md` which is also shown at the top-level of each +directory. Other kinds of files (html, images, etc) will not be served. + +## Publishing your changes + +Publishing your changes is as easy as committing them and pushing them +upstream. You can collaborate with others on your wiki the same way you +do on your git.sr.ht projects - a mailing list on lists.sr.ht or +any other approach that you like. You can also make your wiki publically +editable in the wiki settings, or give particular people permission to +push to it. + +## Editing in your browser + +You can also make edits in your web browser if you're logged into the +site. Click "edit page" near the top of each page to pull up the editor. +We can make a commit to the repository for you when you're done. + +## Contribute to man.sr.ht + +Until sr.ht mailing list services are built, please submit patches to +this wiki by mail to [sir@cmpwn.com](mailto:sir@cmpwn.com). Thanks! |