path: root/index.md

Welcome to man.sr.ht! Here you will find documentation for sr.ht as a
whole, as well as for many of the projects hosted here. Each wiki here
is a full-blown git repository, which you can clone, edit locally, and
push back here to display on the web again.

# The sr.ht network

This serves as a documentation hub for all of the sites in our network.
What would you like to learn more about?

<dl class="row" style="margin-bottom: 0">
  <div class="col-md-6">
    <dt>builds.sr.ht</dt>
    <dd>
      <a href="/builds.sr.ht">User Manual</a>
      &mdash;
      <a href="/builds.sr.ht/api.md">API Reference</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>git.sr.ht</dt>
    <dd>
      <a href="#">User Manual</a>&mdash;<a href="#">API Reference</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>meta.sr.ht</dt>
    <dd>
      <a href="#">User Manual</a>&mdash;<a href="#">API Reference</a>
    </dd>
  </div>
  <div class="col-md-6">
    <dt>todo.sr.ht</dt>
    <dd>
      <a href="#">User Manual</a>&mdash;<a href="#">API Reference</a>
    </dd>
  </div>
</dl>

# man.sr.ht

Looking to learn more about man.sr.ht itself? This 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!