diff options
| author | VirtualTam <virtualtam@flibidi.net> | 2015-07-22 05:02:10 +0200 |
|---|---|---|
| committer | VirtualTam <virtualtam@flibidi.net> | 2015-08-04 16:02:21 +0200 |
| commit | 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 (patch) | |
| tree | 4726baf18e7057eac3f9b6bdb5991fe6117814fc /doc/Coding-guidelines.html | |
| parent | 96db105e4c0833324f7168edb5673278de8ccd54 (diff) | |
| download | Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.gz Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.zst Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.zip | |
Doc: sync from Wiki, generate HTML
Closes #291
Fixes #227
Modifications
- HTML content: match the new Wiki structure
- Makefile
- generate a custom HTML sidebar
- include the sidebar on all pages
- infer and prepend page titles
- handle relative links
- add title metadata, e.g. Shaarli - <Page Name>
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/Coding-guidelines.html')
| -rw-r--r-- | doc/Coding-guidelines.html | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/Coding-guidelines.html b/doc/Coding-guidelines.html new file mode 100644 index 00000000..0f071a5a --- /dev/null +++ b/doc/Coding-guidelines.html | |||
| @@ -0,0 +1,65 @@ | |||
| 1 | <!DOCTYPE html> | ||
| 2 | <html> | ||
| 3 | <head> | ||
| 4 | <meta charset="utf-8"> | ||
| 5 | <meta name="generator" content="pandoc"> | ||
| 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> | ||
| 7 | <title>Shaarli - Coding guidelines</title> | ||
| 8 | <style type="text/css">code{white-space: pre;}</style> | ||
| 9 | <!--[if lt IE 9]> | ||
| 10 | <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> | ||
| 11 | <![endif]--> | ||
| 12 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Installation | ||
| 19 | <ul> | ||
| 20 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 21 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 22 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 23 | </ul></li> | ||
| 24 | <li><a href="Usage.html">Usage</a> | ||
| 25 | <ul> | ||
| 26 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 27 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 28 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 29 | </ul></li> | ||
| 30 | <li>How To | ||
| 31 | <ul> | ||
| 32 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 33 | <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> | ||
| 34 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 35 | </ul></li> | ||
| 36 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 37 | <li><a href="Development.html">Development</a> | ||
| 38 | <ul> | ||
| 39 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 40 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 41 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 42 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 43 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 44 | <li><a href="Security.html">Security</a></li> | ||
| 45 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 46 | <li><a href="Theming.html">Theming</a></li> | ||
| 47 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 48 | </ul></li> | ||
| 49 | <li>About | ||
| 50 | <ul> | ||
| 51 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 52 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 53 | <li><a href="TODO.html">TODO</a></li> | ||
| 54 | </ul></li> | ||
| 55 | </ul> | ||
| 56 | </div> | ||
| 57 | <h1 id="coding-guidelines">Coding guidelines</h1> | ||
| 58 | <h2 id="wip">WIP</h2> | ||
| 59 | <p>This topic is currently being discussed here:</p> | ||
| 60 | <ul> | ||
| 61 | <li><a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95)<a href=".html"></a></li> | ||
| 62 | <li><a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools & features</a> (#130)<a href=".html"></a></li> | ||
| 63 | </ul> | ||
| 64 | </body> | ||
| 65 | </html> | ||