Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
- root
- |- assets
- |- out
- |- pages
- |- templates
- | |- footer.html
- | |- header.html
- | |- menu.html
- | `- template.html
- `- config.ini
+~~~raw
+root
+|- assets
+|- out
+|- pages
+|- templates
+| |- footer.html
+| |- header.html
+| |- menu.html
+| `- template.html
+`- config.ini
+~~~
You can categorize your content in sections using sub-folders:
You can categorize your content in sections using sub-folders:
- pages
- |- section1
- | `- index.md
- |- section2
- | `- index.md
- |- page1.md
- |- page2.md
- `- index.md
+~~~raw
+pages
+|- section1
+| `- index.md
+|- section2
+| `- index.md
+|- page1.md
+|- page2.md
+`- index.md
+~~~
You can also use this directory to put some images or other files that will be
used in all your pages.
You can also use this directory to put some images or other files that will be
used in all your pages.
- assets
- |- css
- |- js
- `- logo.png
+~~~raw
+assets
+|- css
+|- js
+`- logo.png
+~~~
Just move to the directory where you want to store your source files and type:
Just move to the directory where you want to store your source files and type:
+~~~sh
+nitiwiki init
+~~~
This command will import the base structure of your wiki in the current directory.
At this point nitiwiki has created the main configuration file of your site:
This command will import the base structure of your wiki in the current directory.
At this point nitiwiki has created the main configuration file of your site:
Once you have done your changes, use:
Once you have done your changes, use:
+~~~sh
+nitiwiki --status
+~~~
This will show the impacts of your changes on the wiki structure.
Then type:
This will show the impacts of your changes on the wiki structure.
Then type:
+~~~sh
+nitiwiki --render
+~~~
This will the generate the html output of your new content.
The option `--force` can be used to regenerate all the wiki.
This will the generate the html output of your new content.
The option `--force` can be used to regenerate all the wiki.
The template file `template.html` represents the overall structure of your wiki pages.
The template file `template.html` represents the overall structure of your wiki pages.
- <!DOCTYPE html>
- <html>
- <head>
- <title>%TITLE%</title>
- <link href="%ROOT_URL%/assets/css/main.css" rel="stylesheet">
- </head>
- <body>
- %HEADER%
- %TOP_MENU%
- <div>
- %TRAIL%
- %BODY%
- %TRAIL%
- %FOOTER%
- </div>
- </body>
- </html>
+~~~html
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>%TITLE%</title>
+ <link href="%ROOT_URL%/assets/css/main.css" rel="stylesheet">
+ </head>
+ <body>
+ %HEADER%
+ %TOP_MENU%
+ <div>
+ %TRAIL%
+ %BODY%
+ %TRAIL%
+ %FOOTER%
+ </div>
+ </body>
+</html>
+~~~
The template file `header.html` is generated on top of all the wiki pages.
The template file `header.html` is generated on top of all the wiki pages.
- <header>
- <a href="#"><img src="%ROOT_URL%/%LOGO%" alt="logo"/></a>
- <h2>%SUBTITLE%</h2>
- <h1>%TITLE%</h1>
- </header>
+~~~html
+<header>
+ <a href="#"><img src="%ROOT_URL%/%LOGO%" alt="logo"/></a>
+ <h2>%SUBTITLE%</h2>
+ <h1>%TITLE%</h1>
+</header>
+~~~
### Footer template
The template file `footer.html` is generated on the bottom of all the wiki pages.
### Footer template
The template file `footer.html` is generated on the bottom of all the wiki pages.
- <footer>
- <p>%TITLE% © %YEAR%</p>
- <p>last modification %GEN_TIME%</p>
- </footer>
+~~~html
+<footer>
+ <p>%TITLE% © %YEAR%</p>
+ <p>last modification %GEN_TIME%</p>
+</footer>
+~~~
Its content can be static:
Its content can be static:
- <nav class="menu">
- <ul class="nav navbar-nav">
- <li><a href="#">Home</a></li>
- <li><a href="#">Page1</a></li>
- <li><a href="#">Page2</a></li>
- </ul>
- </nav>
+~~~html
+<nav class="menu">
+ <ul class="nav navbar-nav">
+ <li><a href="#">Home</a></li>
+ <li><a href="#">Page1</a></li>
+ <li><a href="#">Page2</a></li>
+ </ul>
+</nav>
+~~~
Or dynamic using the macro `MENUS`:
Or dynamic using the macro `MENUS`:
- <nav class="menu">
- <ul class="nav navbar-nav">
- %MENUS%
- </ul>
- </nav>
+~~~html
+<nav class="menu">
+ <ul class="nav navbar-nav">
+ %MENUS%
+ </ul>
+</nav>
+~~~
To automatically update your wiki when changes are pushed on the
origin repository you can use the following command in a git hook:
To automatically update your wiki when changes are pushed on the
origin repository you can use the following command in a git hook:
- nitiwiki --fetch --render
+~~~sh
+nitiwiki --fetch --render
+~~~
### Working with a remote server
### Working with a remote server
Using the following command in your cron will update the web server instance
from git:
Using the following command in your cron will update the web server instance
from git:
- nitiwiki --fetch --render --rsync
+~~~sh
+nitiwiki --fetch --render --rsync
+~~~
Be sure to set `wiki.rsync_dir` in order to correctly push your changes.
When using `--rsync`, keep in mind that the rendered output must be configured
Be sure to set `wiki.rsync_dir` in order to correctly push your changes.
When using `--rsync`, keep in mind that the rendered output must be configured