Skip to content

Commit c4cd972

Browse files
committed
1.3.2
1 parent 95fd940 commit c4cd972

File tree

5 files changed

+15
-20
lines changed

5 files changed

+15
-20
lines changed

changelog.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Changelog
22

3-
## Next
3+
## 1.3.2
4+
*2024-05-08*
45
- Fixed `nowiki` content not being fully unparsed.
56
- Fixed output files not having the correct path to the default stylesheet.
67
- Fixed URLs in output files being absolute.
78
- Fixed various issues with incorrect outputted file names.
89
- Fixed `||` not being treated as valid table cell syntax.
910
- Fixed front matter being generated even when config option `eleventy` was set to `false`.
1011
- Fixed defaults not being used when `compile` called from CLI.
12+
- Unmarked Eleventy as a peer dependency.
1113

1214
## 1.3.1
1315
*2024-05-03*

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "wikity",
3-
"version": "1.3.1",
3+
"version": "1.3.2",
44
"description": "Compile wikitext to HTML: wikitext as a templating language.",
55
"main": "dist/index.js",
66
"scripts": {
@@ -44,14 +44,6 @@
4444
"glob": "^8.1.0",
4545
"html-formatter": "^0.1.9"
4646
},
47-
"peerDependencies": {
48-
"@11ty/eleventy": ">=0.10.0"
49-
},
50-
"peerDependenciesMeta": {
51-
"@11ty/eleventy": {
52-
"optional": true
53-
}
54-
},
5547
"devDependencies": {
5648
"@types/dateformat": "^3.0.1",
5749
"@types/dedent": "^0.7.2",

readme.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,13 @@ Use Wikity along with Eleventy to have all your wiki files compiled during the b
6969
// .eleventy.js (eleventy's configuration file)
7070
const wikity = require('wikity');
7171
module.exports = function (eleventyConfig) {
72-
const wikiFolder = 'src';
73-
const templatesFolder = 'templates', imagesFolder = 'images', outputFolder = 'wikity-out'; // defaults
74-
const wikityOptions = { templatesFolder, imagesFolder, outputFolder };
75-
const wikityPlugin = () => wikity.compile(wikiFolder, { eleventy: true, ...wikityOptions });
72+
const rootFolder = 'src';
73+
const templatesFolder = 'templates', imagesFolder = 'images'; // defaults; relative to root folder
74+
const outputFolder = 'wikity-out'; // default
75+
const wikityOptions = { eleventy: true, templatesFolder, imagesFolder, outputFolder };
76+
const wikityPlugin = () => wikity.compile(rootFolder, wikityOptions);
7677
eleventyConfig.addPlugin(wikityPlugin);
77-
eleventyConfig.addPassthroughCopy({[imagesFolder]: 'wiki/' + imagesFolder}); // Eleventy does not pass through images by default
78+
eleventyConfig.addPassthroughCopy({ 'src/images': 'wiki/' + imagesFolder }); // Eleventy does not pass through images by default
7879
}
7980
```
8081

@@ -83,10 +84,10 @@ The above will use the following file structure (with some example wiki files gi
8384
- `src/`
8485
- `templates/`: Directory for wiki templates (called like `{{this}}`)
8586
- `images/`: Directory to place images (called like `[[File:this]]`)
86-
- `wikity-out/`: File templates compiled from the `.wiki` files (add this to `.gitignore`)
8787
- `Index.wiki`: Example file
8888
- `Other_Page.wiki`: Example other file
89-
- `wiki/`: Output HTML files compiled from wikity-out (add this to `.gitignore`)
89+
- `wikity-out/`: File templates compiled from the `.wiki` files (add this to `.gitignore`)
90+
- `wiki/`: Output HTML files compiled from `wikity-out/` (add this to `.gitignore`)
9091

9192
(View the above starting at the URL path `/wiki/` when ran in an HTTP server.)
9293

test/src/example.wiki

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ __TOC__
3939
</div>
4040

4141
<div style="border:1px solid">
42-
<h1>Rule</h1>
42+
<h1>HorizontalRule</h1>
4343
-----
4444
</div>
4545

0 commit comments

Comments
 (0)