% Protocol.Club "Wiki" (beta)
% Anonymous
%

## How to get started with this wiki

Log into your protocol.club shell account and run:

    git clone ~datagrok/public_html/beta-wiki

Create and edit files to your heart's content. When you're done, `git add` the files, `git commit` your changes, and `git push` the commits to the server. That's it, your changes should go live automatically.

Auto-compilation features:

- Files named like "(something).text" will be treated as markdown format and rendered to "(something).html".

- Files named like "(something).exec" and which are marked executable will be executed, and their output will be saved without the .exec extension. In other words: if you have a shell script that outputs html, name it "(something).html.exec" and `chmod +x` it. For a script that outputs JSON, name it "(something).json.exec". Your script may be any language that protocol.club supports including python or shell script, or it could even be a compiled executable. Anything that runs from the command line on protocol.club should work.

- Files named like "(something).text.exec" will be executed as above, then their output will be treated as markdown and rendered as HTML!

Note that the source code for .exec files may be served to visitors, so don't put passwords, API keys, or other confidential information in them.

If you have trouble, contact [~datagrok][].

## Protocols

-   [Protocols we're interested in](protocols.html)

-   [Tools for protocol analysis](tools.html)

-   [Resources for documenting standards (e.g. as RFCs, I-Ds, etc.)](how-to-rfc.html)

## Meta

-   A list of [all the pages in this wiki](map.html) (auto-generated).

-   HTML version of the [Code of Conduct](coc.html) (if you're not big on Google Docs)

-   [Protocol.club Wiki Meta](meta.html) (more information about the wiki itself)

[~datagrok]: /~datagrok/
