-
JavaScript
-
impress( [ id ] )
-
A factory function that creates the ImpressAPI.
+
JavaScript
+
impress( [ id ] )
+
A factory function that creates the ImpressAPI.
Accepts a String that represents the id of the root element in the page. If omitted, impress.js will lookup for the element with the id "impress" by default.
Example:
var impressAPI = impress( "root" );
-
ImpressAPI
+
ImpressAPI
The main impress.js API that handles common operations of impress.js, listed below.
-
.init()
+
.init()
Initializes impress.js globally in the page. Only one instance of impress.js is supported per document.
Example:
impress().init();
-
Triggers the impress:init event in the Root Element after the presentation is initialized.
+
Triggers the impress:init event in the Root Element after the presentation is initialized.
Example:
var rootElement = document.getElementById( "impress" );
rootElement.addEventListener( "impress:init", function() {
@@ -39,7 +39,7 @@ rootElement.addEventListener( "impress:init", function() {
});
impress().init();
-
.tear()
+
.tear()
Resets the DOM to its original state, as it was before init() was called.
This can be used to "unload" impress.js. A particular use case for this is, if you want to do
dynamic changes to the presentation, you can do a teardown, apply changes, then call init()
@@ -48,21 +48,21 @@ beyond the intended dynamic changes.)
Example:
impress().tear();
-
.next()
-
Navigates to the next step of the presentation using the goto() function.
+
.next()
+
Navigates to the next step of the presentation using the goto() function.
Example:
var api = impress();
api.init();
api.next();
-
.prev()
-
Navigates to the previous step of the presentation using the goto() function.
+
.prev()
+
Navigates to the previous step of the presentation using the goto() function.
Example:
var api = impress();
api.init();
api.prev();
-
.goto( stepIndex | stepElementId | stepElement, [ duration ] )
+
.goto( stepIndex | stepElementId | stepElement, [ duration ] )
Accepts a Number that represents the step index.
Navigates to the step given the provided step index.
Example:
@@ -70,15 +70,15 @@ api.prev();
api.init();
api.goto(7);
-
Accepts a String that represents the Step Element id.
-
Navigates to the step given the provided Step Element id.
+
Accepts a String that represents the Step Element id.
+
Navigates to the step given the provided Step Element id.
Example:
var api = impress();
api.init();
api.goto( "overview" );
-
Accepts an HTMLElement that represents the Step Element.
-
Navigates to the step given the provided Step Element.
+
Accepts an HTMLElement that represents the Step Element.
+
Navigates to the step given the provided Step Element.
Example:
var overview = document.getElementById( "overview" );
var api = impress();
@@ -86,7 +86,7 @@ api.init();
api.goto( overview );
Accepts an optional Number in the last argument that represents the duration of the transition in milliseconds. If not provided, the default transition duration for the presentation will be used.
-
Triggers the impress:stepenter event in the Root Element when the presentation navigates to the target Step Element.
+
Triggers the impress:stepenter event in the Root Element when the presentation navigates to the target Step Element.
Example:
var rootElement = document.getElementById( "impress" );
rootElement.addEventListener( "impress:stepenter", function(event) {
@@ -94,7 +94,7 @@ rootElement.addEventListener( "impress:stepenter", function(event) {
console.log( "Entered the Step Element '" + currentStep.id + "'" );
});
-
Triggers the impress:stepleave event in the Root Element when the presentation navigates away from the current Step Element.
+
Triggers the impress:stepleave event in the Root Element when the presentation navigates away from the current Step Element.
Example:
var rootElement = document.getElementById( "impress" );
rootElement.addEventListener( "impress:stepleave", function(event) {
diff --git a/website/docs/reference/Plugins.html b/website/docs/reference/Plugins.html
index 9647f78..220107f 100644
--- a/website/docs/reference/Plugins.html
+++ b/website/docs/reference/Plugins.html
@@ -17,8 +17,8 @@
diff --git a/website/docs/src/build.js b/website/docs/src/build.js
index 288e730..d3ed4cc 100644
--- a/website/docs/src/build.js
+++ b/website/docs/src/build.js
@@ -43,17 +43,20 @@ if ( prompt( 'Do you want to regenerate the API reference? (y/n) ' ).toLowerCase
parseDocumentationMD();
}
-if ( prompt( 'Do you want to regenerate the Getting Started Guide? (y/n) ' ).toLowerCase() == 'y' ) {
+if ( prompt( 'Do you want to regenerate the getting started guide? (y/n) ' ).toLowerCase() == 'y' ) {
console.log( 'Regenerating Getting Started Guide' );
storeHTML( generateGettingStarted( md2html.render( '' + fs.readFileSync( path.join( __dirname + '/../../../GettingStarted.md' ) ) ) ), 'gettingStarted', '' );
}
-console.log( 'regenerating plugins documentation' );
let docPages = fs.readdirSync( __dirname + '/../../../website/docs/reference' );
-for ( let obj in docPages ) {
- if ( docPages[obj] == 'index.html' ) {
- delete docPages[obj];
- };
+
+if ( prompt( 'Do you want to regenerate the plugins documentation? (y/n) ' ).toLowerCase() == 'y' ) {
+ console.log( 'regenerating plugins documentation' );
+ for ( let obj in docPages ) {
+ if ( docPages[obj] == 'index.html' ) {
+ delete docPages[obj];
+ };
+ }
}
console.log( 'regenerating Nav' );
@@ -221,6 +224,9 @@ function parseDocumentationMD () {
lastHashtagPos = parseInt( letter );
};
};
+
+ let titles = {};
+
for ( let item in posArray ) {
let titleArea = doc.slice( parseInt( posArray[item] ), parseInt( posArray[item] + 20 ) );
let title = '';
@@ -232,9 +238,45 @@ function parseDocumentationMD () {
};
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 ) {
+ let titleTag = page.slice( parseInt( letter ), parseInt( letter ) + 4 );
+ if ( titleTag === '