Browse Source

Fixes and additions

Added documentation about automatic H2 item addition to ToC
Fixed issue when copying files which already existed (are now
overwritten)
Bumped version to v0.7.2
tags/0.7.2
Frans Bouma 10 years ago
parent
commit
17469e7d52
3 changed files with 5 additions and 2 deletions
  1. +3
    -0
      readme.md
  2. +1
    -1
      src/Constants.cs
  3. +1
    -1
      src/Utils.cs

+ 3
- 0
readme.md View File

@@ -55,6 +55,9 @@ Each level, starting with the root, has a special page defined, `__index`. This
### Levels without __index defined ### Levels without __index defined
If a level has no `__index` defined, `DocNet` will create a `__index` entry for the level and will specify as target `<path to index of parent>/nameoflevel.md`. If the page exists it will be loaded as the content for the index of the level, if it doesn't exist, the HTML will simply contain the topictitle and a list of all the sub topics in the level. This guarantees the tree can always be navigated in full. If a level has no `__index` defined, `DocNet` will create a `__index` entry for the level and will specify as target `<path to index of parent>/nameoflevel.md`. If the page exists it will be loaded as the content for the index of the level, if it doesn't exist, the HTML will simply contain the topictitle and a list of all the sub topics in the level. This guarantees the tree can always be navigated in full.


## Automatic H2 level ToC entry discovery
`Docnet` will automatically add all H2 (`##` marked) headers to the ToC as sub navigation elements below a page ToC item. It will automatically add anchors to these H2 headers in the HTML output for the page as well. This makes it very easy to create a fine-grained ToC for easy discovery.

## Themes ## Themes
`Docnet` uses themes to produce output in a certain form. A theme is a folder within the `Themes` folder which contains a `PageTemplate.htm` file and a `Destination` folder which contains zero or more folders and files which have to be copied to the `Destination` folder specified in the `docnet.json` file. `Docnet` uses themes to produce output in a certain form. A theme is a folder within the `Themes` folder which contains a `PageTemplate.htm` file and a `Destination` folder which contains zero or more folders and files which have to be copied to the `Destination` folder specified in the `docnet.json` file.




+ 1
- 1
src/Constants.cs View File

@@ -30,6 +30,6 @@ namespace Docnet
{ {
public class Constants public class Constants
{ {
public const string Version = "0.7.1";
public const string Version = "0.7.2";
} }
} }

+ 1
- 1
src/Utils.cs View File

@@ -68,7 +68,7 @@ namespace Docnet
// Get the files in the directory and copy them to the new location. // Get the files in the directory and copy them to the new location.
foreach(FileInfo file in sourceFolder.GetFiles()) foreach(FileInfo file in sourceFolder.GetFiles())
{ {
file.CopyTo(Path.Combine(destinationFolderName, file.Name), false);
file.CopyTo(Path.Combine(destinationFolderName, file.Name), true);
} }
if(copySubFolders) if(copySubFolders)
{ {


Loading…
Cancel
Save