diff --git a/website/docs/nav.html b/website/docs/nav.html index 00fc1d3..46f6af0 100644 --- a/website/docs/nav.html +++ b/website/docs/nav.html @@ -13,7 +13,7 @@ Getting Started API reference + HomeCSS.htmlHTML.htmlJavaScript.htmlPlugins.html Plugins diff --git a/website/docs/reference/CSS.html b/website/docs/reference/CSS.html index 1669831..56908a7 100644 --- a/website/docs/reference/CSS.html +++ b/website/docs/reference/CSS.html @@ -49,7 +49,7 @@ opacity: 1 } -

At the same time, the impress-on-* class is added to the body element, the class name represents the active Step Element id. This allows for custom global styling, since you can't match a CSS class backwards from the active Step Element to the body.

+

At the same time, the impress-on-* class is added to the body element, the class name represents the active Step Element id. This allows for custom global styling, since you can't match a CSS class backwards from the active .impress-on-overview .step { opacity: 1; diff --git a/website/docs/reference/HTML.html b/website/docs/reference/HTML.html index fb876c3..a141da4 100644 --- a/website/docs/reference/HTML.html +++ b/website/docs/reference/HTML.html @@ -184,7 +184,7 @@ the value of the previous slide. This means, you need to explicitly set these va

3D Rotation Order (data-rotate-order)

The order in which the CSS rotateX(), rotateY(), rotateZ() transforms are applied matters. This is because each rotation is relative to the then current position of the element.

-

By default the rotation order is data-rotate-order="xyz". For some advanced uses you may need to change it. The demo presentation 3D rotations sets this attribute to rotate some steps into positions that are impossible to reach with the default order.

+

By default the rotation order is data-rotate-order="xyz". For some advanced uses you may need to change it. The demo presentation diff --git a/website/docs/reference/JavaScript.html b/website/docs/reference/JavaScript.html index 6b9e7de..27b66d9 100644 --- a/website/docs/reference/JavaScript.html +++ b/website/docs/reference/JavaScript.html @@ -104,7 +104,7 @@ rootElement.addEventListener( "impress:stepleave", function(event) { });

Improve The Docs

-

Did you find something that can be improved? Then create an issue so that we can discuss it!

+

Did you find something that can be improved? Then diff --git a/website/docs/reference/Plugins.html b/website/docs/reference/Plugins.html index a0888ec..9647f78 100644 --- a/website/docs/reference/Plugins.html +++ b/website/docs/reference/Plugins.html @@ -18,7 +18,7 @@

Plugins

-

Many new features are implemented as plugins. The Plugins documentation is the starting place to learn about those, as well as the README.md of each plugin.

+

Many new features are implemented as plugins. The Plugins documentation is the starting place to learn about those, as well as the README.md of

diff --git a/website/docs/src/build.js b/website/docs/src/build.js index 0ea9502..6578fcf 100644 --- a/website/docs/src/build.js +++ b/website/docs/src/build.js @@ -122,6 +122,10 @@ function checkLinks ( link, fpath ) { }; }; +/* + This function generates & stores the HTML in the correct directory +*/ + function storeHTML ( html, path, type ) { let fileOut = ` @@ -152,7 +156,9 @@ function storeHTML ( html, path, type ) { fs.writeFileSync( docRoot + '/' + type + '/' + path + '.html', fileOut ); }; - +/* + This function, as the name implies, generates the navbar on the side in the docs. +*/ function generateNav () { let fileStruct = ` @@ -171,7 +177,7 @@ function generateNav () { Plugins @@ -217,6 +223,45 @@ function parseDocumentationMD () { break; }; }; - storeHTML( md2html.render( doc.slice( parseInt( posArray[parseInt( item )] ), parseInt( posArray[parseInt( item ) + 1] ) || parseInt( doc.length ) ) ), title, 'reference' ); + + let page = md2html.render( doc.slice( parseInt( posArray[parseInt( item )] ), parseInt( posArray[parseInt( item ) + 1] ) || parseInt( doc.length ) ) ); + let updatedPage = page; + + for ( let letter in page ) { + if ( page[letter] === '<' ) { + if ( page.slice( parseInt( letter ), parseInt( letter ) + 9 ) === '' ) { + let i = 9; + while ( page.slice( parseInt( letter ) + i, parseInt( letter ) + i + 1 ) !== '<' ) { + i += 1; + }; + let heading = '' + page.slice( parseInt( letter ) + 9, parseInt( letter ) + i ); + } + }; + storeHTML( updatedPage, title, 'reference' ); + } } } \ No newline at end of file