Skip to content

Home

Jump to bottom
Martii edited this page Aug 15, 2014 · 50 revisions

Welcome

Welcome to the icon OpenUserJS.org (OUJS) wiki!

Guidelines for Contributing

  • Please do use absolute urls for GitHub references other than OpenUserJS.org and don't use wiki urls e.g.

OKAY

[somePageOnOUJSwiki]: ../wiki/Some-Document
[somePageOnOtherWikis]: https://github.com/someOrganization/someProject/wiki/Some-Document
[some name on other wikis][somePageOnOtherWikis]
[some name on OpenUserJS wiki][somePageOnOUJSwiki]

... instead of...

NOT OKAY

[[some name | someDocument]]

NOTE: This is still being finalized but appears to be what needs to be done to have multiple site support in the short term.

  • First line should always be a h2 with the document title and should be the only h2. e.g.
## Some Title

  • Always use h2 through h6 and never use h1.

  • Images should always go in the images subfolder and never attached.

  • All .md files should be in the first tier and never in a subfolder.

  • Always use Link and image references and always at the bottom of the file.

  • Link and Image references should be camel-cased and always at the bottom of the file.

  • OUJS site wiki .md Links should not include the .md

  • All wiki pages must be in markdown format. Avoid using HTML markup.

  • Pages should have a final newline at the end of the file

Clone this wiki locally