Skip to content

Commit

Permalink
generate output
Browse files Browse the repository at this point in the history
  • Loading branch information
@ankitskvmdam
ankitskvmdam committed Mar 20, 2024
1 parent 3a9695f commit 80b64db
Show file tree
Hide file tree
Showing 13 changed files with 893 additions and 625 deletions.
9 changes: 7 additions & 2 deletions output/v4/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
'Mixins',
'Tutorials',
'Interfaces',
'Global'
'Global',
];
</code></pre><h3 id="meta">Meta</h3><p>There is also an option to add meta tag to every generated HTML file. You can use <code>meta</code> option to include a list of <code>meta</code> tags into <code>head</code>.</p><pre class="prettyprint source lang-json"><code>&quot;theme_opts&quot;: {
&quot;meta&quot;: [
Expand Down Expand Up @@ -188,7 +188,12 @@
&quot;footer&quot;: &quot;This is footer&quot; // or &lt;div class=&quot;footer-wrapper&quot;>This is a footer &lt;/div>
}
</code></pre><h3 id="to-exclude-inherited">To exclude inherited</h3><p>To exclude inherited symbols. Example:</p><pre class="prettyprint source lang-json"><code>&quot;exclude_inherited&quot;: true
</code></pre><p>This will remove all symbols (members, methods ...) that come from inherited parents.</p><h2 id="cheat-sheet">Cheat sheet</h2><table><thead><tr><th>name</th><th>default</th><th>use case</th><th>expected value(s)</th></tr></thead><tbody><tr><td><code>default_theme</code></td><td><code>&quot;dark&quot;</code></td><td>To set the default theme</td><td><code>&quot;light&quot;, &quot;dark&quot;</code>, <code>&quot;fallback-light&quot;</code> or <code>&quot;fallback-dark&quot;</code></td></tr><tr><td><code>homepageTitle</code></td><td>&quot;Home&quot;</td><td>To set the title of homepage</td><td><code>string</code></td></tr><tr><td><code>title</code></td><td><code>null</code></td><td>To set the title</td><td><code>HTML</code> or <code>string</code></td></tr><tr><td><code>base_url</code></td><td><code>/</code></td><td>To set the base URL</td><td><code>string</code></td></tr><tr><td><code>menu</code></td><td><code>null</code></td><td>To render extra link in navbar</td><td>Array of Object(s)</td></tr><tr><td><code>meta</code></td><td><code>null</code></td><td>Meta tag attributes</td><td>Array of Object(s)</td></tr><tr><td><code>search</code></td><td><code>true</code></td><td>To render search or not</td><td><code>true</code> or <code>false</code></td></tr><tr><td><code>codepen</code></td><td><code>{}</code></td><td>To open code in codepen</td><td><code>Object</code></td></tr><tr><td><code>static_dir</code></td><td><code>null</code></td><td>To include static dir</td><td>Array of string</td></tr><tr><td><code>create_style</code></td><td><code>null</code></td><td>To create custom style rules</td><td><code>string</code></td></tr><tr><td><code>add_style_path</code></td><td><code>null</code></td><td>To add external css libraries/files</td><td>Array of Object(s)</td></tr><tr><td><code>include_css</code></td><td><code>null</code></td><td>To include css files</td><td>Array of string</td></tr><tr><td><code>add_scripts</code></td><td><code>null</code></td><td>To create custom script</td><td><code>string</code></td></tr><tr><td><code>add_script_path</code></td><td><code>null</code></td><td>To add external js libraries/files</td><td>Array of Object(s)</td></tr><tr><td><code>include_js</code></td><td><code>null</code></td><td>To include js files</td><td><code>string</code></td></tr><tr><td><code>footer</code></td><td><code>null</code></td><td>To render footer</td><td><code>HTML</code> or <code>string</code></td></tr><tr><td><code>exclude_inherited</code></td><td><code>false</code></td><td>To exclude inherited symbols</td><td><code>boolean</code></td></tr><tr><td><code>sections</code></td><td><code>[&quot;Modules&quot;, &quot;Classes&quot;, &quot;Externals&quot;, &quot;Events&quot;, &quot;Namespaces&quot;, &quot;Mixins&quot;, &quot;Tutorials&quot;, &quot;Interfaces&quot;, &quot;Global&quot;]</code></td><td>To order navbar/sidebar sections or to hide/remove navbar/sidebar sections</td><td><code>Array&lt;SECTION_TYPE&gt;</code></td></tr><tr><td><code>displayModuleHeader</code></td><td><code>false</code></td><td>If you want the module name to appear on its page</td><td><code>boolean</code></td></tr><tr><td><code>includeFilesListInHomepage</code></td><td><code>false</code></td><td>If you want to add or remove the list of files in homepage</td><td><code>boolean</code></td></tr><tr><td><code>sort</code></td><td><code>true</code></td><td>To sort the output members/methods/events</td><td><code>boolean</code></td></tr></tbody></table><p>Don't forget to add the following in your jsdoc config file, otherwise toc will not work on some pages.</p><pre class="prettyprint source lang-json"><code>&quot;markdown&quot;: {
</code></pre><p>This will remove all symbols (members, methods ...) that come from inherited parents.</p><h3 id="to-remove-styled-applied-to-scrollbar">To remove styled applied to scrollbar</h3><p>By default <code>clean-jsdoc-theme</code> applies some styles to browser's scroll bar. However if you want to remove this style do the following</p><pre class="prettyprint source lang-json"><code>{
&quot;theme_opts&quot;: {
&quot;shouldRemoveScrollbarStyle&quot;: false
}
}
</code></pre><p>This will remove all symbols (members, methods ...) that come from inherited parents.</p><h2 id="cheat-sheet">Cheat sheet</h2><table><thead><tr><th>name</th><th>default</th><th>use case</th><th>expected value(s)</th></tr></thead><tbody><tr><td><code>default_theme</code></td><td><code>&quot;dark&quot;</code></td><td>To set the default theme</td><td><code>&quot;light&quot;, &quot;dark&quot;</code>, <code>&quot;fallback-light&quot;</code> or <code>&quot;fallback-dark&quot;</code></td></tr><tr><td><code>homepageTitle</code></td><td>&quot;Home&quot;</td><td>To set the title of homepage</td><td><code>string</code></td></tr><tr><td><code>title</code></td><td><code>null</code></td><td>To set the title</td><td><code>HTML</code> or <code>string</code></td></tr><tr><td><code>base_url</code></td><td><code>/</code></td><td>To set the base URL</td><td><code>string</code></td></tr><tr><td><code>menu</code></td><td><code>null</code></td><td>To render extra link in navbar</td><td>Array of Object(s)</td></tr><tr><td><code>meta</code></td><td><code>null</code></td><td>Meta tag attributes</td><td>Array of Object(s)</td></tr><tr><td><code>search</code></td><td><code>true</code></td><td>To render search or not</td><td><code>true</code> or <code>false</code></td></tr><tr><td><code>codepen</code></td><td><code>{}</code></td><td>To open code in codepen</td><td><code>Object</code></td></tr><tr><td><code>static_dir</code></td><td><code>null</code></td><td>To include static dir</td><td>Array of string</td></tr><tr><td><code>create_style</code></td><td><code>null</code></td><td>To create custom style rules</td><td><code>string</code></td></tr><tr><td><code>add_style_path</code></td><td><code>null</code></td><td>To add external css libraries/files</td><td>Array of Object(s)</td></tr><tr><td><code>include_css</code></td><td><code>null</code></td><td>To include css files</td><td>Array of string</td></tr><tr><td><code>add_scripts</code></td><td><code>null</code></td><td>To create custom script</td><td><code>string</code></td></tr><tr><td><code>add_script_path</code></td><td><code>null</code></td><td>To add external js libraries/files</td><td>Array of Object(s)</td></tr><tr><td><code>include_js</code></td><td><code>null</code></td><td>To include js files</td><td><code>string</code></td></tr><tr><td><code>footer</code></td><td><code>null</code></td><td>To render footer</td><td><code>HTML</code> or <code>string</code></td></tr><tr><td><code>exclude_inherited</code></td><td><code>false</code></td><td>To exclude inherited symbols</td><td><code>boolean</code></td></tr><tr><td><code>sections</code></td><td><code>[&quot;Modules&quot;, &quot;Classes&quot;, &quot;Externals&quot;, &quot;Events&quot;, &quot;Namespaces&quot;, &quot;Mixins&quot;, &quot;Tutorials&quot;, &quot;Interfaces&quot;, &quot;Global&quot;]</code></td><td>To order navbar/sidebar sections or to hide/remove navbar/sidebar sections</td><td><code>Array&lt;SECTION_TYPE&gt;</code></td></tr><tr><td><code>displayModuleHeader</code></td><td><code>false</code></td><td>If you want the module name to appear on its page</td><td><code>boolean</code></td></tr><tr><td><code>includeFilesListInHomepage</code></td><td><code>false</code></td><td>If you want to add or remove the list of files in homepage</td><td><code>boolean</code></td></tr><tr><td><code>sort</code></td><td><code>true</code></td><td>To sort the output members/methods/events</td><td><code>boolean</code></td></tr><tr><td><code>shouldRemoveScrollbarStyle</code></td><td><code>false</code></td><td>To remove styles applied to browser's scrollbar</td><td><code>boolean</code></td></tr></tbody></table><p>Don't forget to add the following in your jsdoc config file, otherwise toc will not work on some pages.</p><pre class="prettyprint source lang-json"><code>&quot;markdown&quot;: {
&quot;idInHeadings&quot;: true // This is important for clean-jsdoc-theme, otherwise some features might not work.
}
</code></pre><h2 id="changelog">Changelog</h2><p>Changelog is moved to <a href="https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CHANGELOG.md">https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CHANGELOG.md</a></p><h2 id="developing">Developing</h2><p>Before starting please go through our <a href="https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CONTRIBUTING.md">contributing guide</a>.</p><pre class="prettyprint source lang-bash"><code>git clone https://github.com/ankitskvmdam/clean-jsdoc-theme.git
Expand Down
Loading

0 comments on commit 80b64db

Please sign in to comment.