Commits

Anonymous committed 6e0720c

Correct typography in the doc

  • Participants
  • Parent commits 2e2f139

Comments (0)

Files changed (4)

doc/pages/contribute.md

 
 ### Sources
 
-You can get the sources by cloning the dedicated git repository :
+You can get the sources by cloning the dedicated git repository:
 {{
     git clone git://git.isomorphis.me/stone.git
 }}
 
-You can also access the online cgit interface to the repo :
+You can also access the online cgit interface to the repo:
 [git.isomorphis.me/stone/](http://git.isomorphis.me/stone/)
 
 ### Sending patches
 
 You have made a modification to *Stone* you are very proud of, and you
-want it to be integrated upsteam ? No problem ! You just have to :
+want it to be integrated upsteam? No problem  You just have to:
 * Format your patches with `git format-patch`. Refer to the
   corresponding man page if needed.
 * Send me the patch via [e-mail](contact.html)

doc/pages/get-it.md

 
 Once OPAM is initialized, install the two required libraries
  ([Cow](https://github.com/mirage/ocaml-cow) and
- [Config_file](http://config-file.forge.ocamlcore.org/)) :
+ [Config_file](http://config-file.forge.ocamlcore.org/)):
  
  {{
      opam install cow config-file
  }}
 
 Now that we have setup the compilation environnment, we can get
-*Stone* sources' :
+*Stone* sources':
 
 {{
     git clone git://git.isomorphis.me/stone.git
 }}
 
-And then, build them : 
+And then, build them:
 {{
     cd stone/
     make
     cd ..
 }}
 
-That's it ! Now you have a binary named `stone` in the `stone` folder
-(how surprising !).
+That's it! Now you have a binary named `stone` in the `stone` folder
+(how surprising!).

doc/pages/index.md

-## « Just write it » : easily generate portfolios, documentation, ...
+## "Just write it": easily generate portfolios, documentation, ...
 
-*Stone* is a static website generator : it takes a template, a css
+*Stone* is a static website generator: it takes a template, a css
  stylesheet, the content itself written in a high-level formatting
  syntax, and generates the corresponding html pages.
  
- However, *Stone* isn't a generalistic one : his goal is to provide a
+ However, *Stone* isn't a generalistic one: his goal is to provide a
  very easy way to generate simple websites like a portfolio, or the
  pages of documentation for a small project. That is quite limitated,
  but *Stone* tries to be good at what it aims.
  
 ### First steps with *Stone*
 
-So, let's generate our first *Stone*-based website !
+So, let's generate our first *Stone*-based website!
 
 First, [get Stone](get-it.html). That's the more complicated step of
 the process.
 self-sufficient. I will here assume it is in the current folder.
 
 Type `stone --help` to have some explanations on how to use the
-binary : let's first generate a default website :
+binary : let's first generate a default website:
 
 {{
     ./stone -i my_portfolio
 }}
 
 As you can see, a directory has been initialized with a default
-project, which consists in :
+project, which consists in:
 * A config file (`config.stone`), which holds the title of the
   website, and the list of the pages to display in the title bar
 * A `data` directory, which contains the template and the
 
 You can now tweak the `config.stone` a little, write things in
 `pages`, or just leave the default config. Finally, we can generate
-the html content :
+the html content:
 
 {{
     ./stone my_portfolio
     ls my_portfolio
 }}
 
-A new directory as appeared : `site`. It contains the html pages,
+A new directory as appeared: `site`. It contains the html pages,
 generated by *Stone*. If you have a FTP access to a web server
 somewhere, just upload on it the contents of `site`. You can also
 directly browse its contents locally with your favorite browser.
 * Read the [specifications](specs.html) about the structure of the
   project, the templates and the relevant css properties, and make
   your own templates and themes.
-* Feel free to [contribute](contribute.html) !
+* Feel free to [contribute](contribute.html)!

doc/pages/specs.md

 ### Project structure
 
 If you look into the directory generated by stone by default, you'll
-have :
+have:
 {{
     ├── config.stone
     ├── data
 project. It defines it's name, the pages you want to have in the title
 bar, and other things.
 * The `data` directory contains the static content used to generate
-  the pages :
+  the pages:
 
-  + `template.html` : the template used for markdown pages. See below.
+  + `template.html`: the template used for markdown pages. See below.
   
-  + `style.css` : The stylesheet. The default one is made by
+  + `style.css`: The stylesheet. The default one is made by
     [Theotix](http://theotix.me) (thanks to him).
 * The `pages` directory is where you write the pages with your
   content. If the extension is `.md` or `.markdown`, they'll be parsed
   they will be just copied without modification.
   
 After running `stone` and generating the static pages, a new directory
-appears :
+appears:
 {{
     └── site
         ├── index.html
             └── style.css
 }}
 
-The `site` directory contains the generated content : what you want to
+The `site` directory contains the generated content: what you want to
 send online to be served by your web server.
 
 ### Pages syntax
 
 *Stone*'s pages are written in a easy-to-read and easy-to-write
-formatting syntax : Markdown. In fact, Markdown-like : the parser I
+formatting syntax: Markdown. In fact, Markdown-like: the parser I
 use doesn't implements standard Markdown on some points (you can send
 patches to [Cow](https://github.com/mirage/ocaml-cow), i would be
 happy).
 [here](http://support.mashery.com/docs/customizing_your_portal/Markdown_Cheat_Sheet)
 
 The differences between the imprementation used by *Stone* and the
-standard are :
+standard are:
 
 * Headings underlined by '`-`'s and '`=`'s are not supported (use '`#`'s)
 * Trailing spaces to put a line break are not supported
 Templates for *Stone* are just plain html pages, with some magic
 variables that will be replaced during the pages generation.
 
-The variables you can use are the following :
+The variables you can use are the following:
 
-* `PAGE_TITLE` : will be replaced by the title's page, if specified in
+* `PAGE_TITLE`: will be replaced by the title's page, if specified in
 the `Pages` variables in the `config.stone` file. Otherwise, is
 replaced by the page's filename prefix (filename without extension).
-* `SITE_TITLE` : replaced by the website's title, specified in the
+* `SITE_TITLE`: replaced by the website's title, specified in the
   `Title` variable in `config.stone`
-* `CSS` : inserts a html snippet which includes the css stylesheet
+* `CSS`: inserts a html snippet which includes the css stylesheet
   present in the `data/` directory (looks like `<link
   href="static//style.css" type="text/css" rel="stylesheet"/>`)
-* `BAR` : replaced by the list of the pages listed in `Pages` in the
+* `BAR`: replaced by the list of the pages listed in `Pages` in the
   `config.stone`. Each item is a link to the page, named by it's
   title.
-* `CONTENT` : the content of the page itself, generated from the
+* `CONTENT`: the content of the page itself, generated from the
   markdown of the page (in the `pages/` directory).
 
 When inserting a variable in your template, you must surrond it by
-'`$`'s : if the var is `VAR`, the string `$VAR$` must be inserted in the
+'`$`'s: if the var is `VAR`, the string `$VAR$` must be inserted in the
 template.
 
 ### Generated pages properties
 
 * When you create a heading (with some '`#`'s), an anchor is created. It
-  is named with the following pattern : if this is a `h3` title, with text `"My
+  is named with the following pattern: if this is a `h3` title, with text `"My
   Title"`, the anchor's name will be `"h3-MyTitle"`.
   It also has class `"anchor-toc"`.
 * The `li` item in the bar list which points out to the current page