Name: docstrap
Owner: Kadence
Description: docstrap theme for kadence.github.io
Created: 2018-03-02 14:25:15.0
Updated: 2018-03-02 15:22:13.0
Pushed: 2018-03-02 21:14:28.0
Homepage: null
Size: 6720
Language: CSS
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
DocStrap is Bootstrap based template for JSDoc3. In addition, it includes all of the themes from Bootswatch giving you a great deal of look and feel options for your documentation, along with a simple search. Additionally, it adds some options to the conf.json file that gives you even more flexibility to tweak the template to your needs. It will also make your teeth whiter.
Here are examples of this template with the different Bootswatch themes:
To change your theme, just change it in the conf.json file. See below for details.
If you manage your own version of jsdoc:
install ink-docstrap
When using grunt, please look at grunt-jsdoc which you can use with docstrap.
c -c path/to/conf.json -t ./node_modules/ink-docstrap/template -R README.md -r .
The -c sets the config, and the docstrap README does talk about the options you can put in templates that docstrap is supposed to look for.
The -t sets the template. This is the option you need to set to get the docstrap template to be used.
The -R sets a markdown file to be the front page of the documentation.
The -r tells jsdoc to run recursively.
The . says from current directory.
DocStrap ships with a conf.json file in the template/ directory. It is just a regular old
JSDoc configuration file, but with the following new options:
plates": {
"systemName" : "{string}",
"footer" : "{string}",
"copyright" : "{string}",
"includeDate" : "{boolean}",
"navType" : "{vertical|inline}",
"theme" : "{theme}",
"linenums" : "{boolean}",
"collapseSymbols" : "{boolean}",
"inverseNav" : "{boolean}",
"outputSourceFiles" : "{boolean}" ,
"outputSourcePath" : "{boolean}",
"dateFormat" : "{string}",
"syntaxTheme" : "{string}",
"sort" : "{boolean|string}"
false"inline". Otherwise set it to "vertical" to make them regular stacked dropdowns.ceruleancosmocyborgflatlyjournallumenpaperreadablesandstonesimplexslatespacelabsuperherounitedyetitrue
all of the symbols in the page will roll their contents up so that you just get a list of symbols that can be expanded
and collapsed."analytics":{"ua":"UA-XXXXX-XXX", "domain":"XXXX"}true to
use the inverse header.outputSourceFiles is false, you may still want to name the file even without a link to the pretty printed output.
Set this to true when outputSourceFiles is false. outputSourceFiles when true takes precedence over this setting."default". It can be any value supported
at sunlight themes which right now consists of…uh…"default" and "dark",
but at least you have it if you need it."longname, version, since".The default language will be JavaScript, but there are a couple of ways to secify the language.
DocStrap support the language specified in the standard way e.g.
trap also introduces a new documentation tag which can appear inside any example block in source code,
n any fenced code block in markdown: `{@lang languageName}`, where
nguage`_ can be any of the languages supported by [Sunlight](http://sunlightjs.com/)
in a doclet, add the tag just after the `@example` tag like this:
ample {@lang xml}`
v>This is the most interesting web site ever</div>`
e are the supported languages.
tionScript
sh
C++
S
ff
S batch
lang
skell
tpd (Apache)
va
vaScript
sp
a
SQL
inx
jective-C
rl
P
werShell
thon
by
ala
SQL
.NET
L (HTML)
Example Caption ###
ou want a caption to your example, add it in a HTML caption before your example e.g.
@example
ustomizing DocStrap ##
emplate can meet every need and customizing templates is a favorite pastime of....well, no-one, but you may need to anyway.
t make sure you have [bower](https://github.com/bower/bower) and [grunt-cli](https://github.com/gruntjs/grunt-cli) installed.
h the source using `git` or grab the [zip file from github.](https://github.com/docstrap/docstrap/archive/master.zip) and unzip
omewhere. Everything that follows happens in the unzip directory.
, prepare the environment:
bower install
npm install
that is done, you have all of the tools to start modifying the template. The template, like Bootstrap, uses [less](http://lesscss.org/).
way it works is that `./styles/main.less` pulls in the bootstrap files uncompiled so that you have access to all of bootstraps mixins, colors,
that you would want. There are two more files in that directory, `variables.less`, `bootswatch.less`. These are the
e files and you can modify them, but keep in mind that if you apply a new theme (see below) those files will be overwritten. It is best
eep your changes to the `main.less` file.
ompile your changes to `main.less` and any other files it loads up,
grunt less
output is will be put in `./template/static/styles/site.<theme-name>.css`. The next time you create your documentation, it
have the new css file included.
pply a different template to the `styles` directory to modify, open up the `conf.json` in the template directory and
ge the `theme` option to the theme you want. Then
grunt apply
the new theme will be in `variables.less`, `bootswatch.less`. Don't forget to compile your changes using `grunt apply` to
that change into the template.
TE** that these steps are not necessary to just change the theme, this is only to modify the theme. If all you want to do is
ge the theme, just update conf.json with the new theme and build your docs!
ontributing ##
Contribute! Test! Share your ideas! Report Bugs!
Contributers ###
e* thanks to all contributors. If your name should be here, but isn't, please let us know
arklagendijk](https://github.com/marklagendijk)
ichaelward82](https://github.com/michaelward82)
austavdm](https://github.com/kaustavdm)
meurisse](https://github.com/vmeurisse)
mathern](https://github.com/bmathern)
rkim123us](https://github.com/jrkim123us)
hawke](https://github.com/shawke)
ar10](https://github.com/mar10)
wcz](https://github.com/mwcz)
ocesar](https://github.com/pocesar)
yperandroid](https://github.com/hyperandroid)
madman](https://github.com/vmadman)
hitelynx](https://github.com/whitelynx)
swaters](https://github.com/tswaters)
ukeapage](https://github.com/lukeapage)
cosnita](https://github.com/rcosnita)
istory ##
.2.1 ##
pdate lunr dependency used for searching
.2.0 ##
dd square brackets around optional parameters
ew option disablePackagePath option which if true makes docstrap not append the package and version to the out path
llow version to be missing in package.json
.1.4 ##
emove the unreadable orange on pre/code tags and use a dark red. Remove white background as is readable on black or white.
.1.3 ##
et sort option from navOptions as per docs
weaks from bootswatch
.1.2 ##
llow example captions to contain markdown if configured in the markdown config `includeTags` section.
ixes full path used as source URL for projects with one source file
llow users to update the default template layout file
.1.1 ##
ootswatch update
dd viewport meta tag to html for better mobile experience
.1.0 ##
dded includeDate option
.0.5 ##
avigation to anchor links now works in IE (with some flicker)
inks to other pages now work (with some flicker in some browsers)
.0.4 ##
earch results no longer erroneously included in side navbar
utorials now get page titles consistent with everything else
mprovements to the highlighted nav heading
.0.3 ##
rop-down shows a scrollbar when too big (regression in 1.0.1)
.0.2 ##
upport older jsdoc by not looking in "interfaces"
.0.1 ##
weak side nav and dropdowns to be the bootswatch style
ake the documentation responsive
.0.0 ##
ump to follow semver (initial development is well and truly over)
orrected list of themes
dded Search
emove highlightTutorialCode option - it didnt work
.5.4 ##
ix layout glitch on hte bottom of code samples
upport for specifying the language for fenced code blocks in the normal way
ix the active item in some themes, which was missing a background
ables get marked as tables
ependency updates
.5.3 ##
emoved duplicate headers
emove "Index" header
e-fixed navigation
emoved some dubious features (now pr's that can be re-added with a little polishing)
.5.2 ##
r update__. Amazing help from [tswaters](https://github.com/tswaters) to solve a bunch of little problems and a to bring the codebase up to Bootstrap3.
sure you are running the latest version of JSDoc before using this build.
n huge, huge thanks to [tswaters](https://github.com/tswaters). Make sure you send him thanks or a tip!!!!!
v0.4.15 ###
Issue #76
Issue #77
v0.4.14 ###
sue #69
v0.4.13 ###
sue #68
v0.4.11 ###
ll Request #59
v0.4.8 ###
sue #58
v0.4.7 ###
sue #57
v0.4.5 ###
sue #55
sue #54
sue #52
sue #51
sue #50
sue #45
sue #44
v0.4.3 ###
sue #46
sue #46
sue #47
v0.4.1-1###
sue #44
date documentation
sue #43
sue #42
sue #34
v0.4.0 ###
sue #41
sue #40
sue #39
sue #36
sue #32
v0.3.0 ###
xed navigation at page top
ds -d switch to example jsdoc command.
xed typo in readme
prove search box positioning and styles
d dynamic quick search in TOC
x for line numbers styling issue
v0.2.0 ###
ded jump to source linenumers - still a problem scrolling with fixed header
anged syntax highlighter to [sunlight](http://sunlightjs.com/)
dify incoming bootswatch files to make font calls without protocol.
v0.1.0 ###
ial release
otices ##
ou like DocStrap, be sure and check out these excellent projects and support them!
oc3 is licensed under the Apache License](https://github.com/jsdoc3/jsdoc/blob/master/LICENSE.md)
is Bootstrap](https://github.com/twitter/bootstrap/blob/master/LICENSE)
Bootswatch](https://github.com/thomaspark/bootswatch/blob/gh-pages/LICENSE)
is licensed under MIT](https://github.com/jgallen23/toc/blob/master/LICENSE)
nt is also MIT](https://github.com/gruntjs/grunt-cli/blob/master/LICENSE-MIT)
trap [is licensed under the MIT license.](https://github.com/docstrap/docstrap/blob/master/LICENSE.md)
light uses the WTFPL](http://sunlightjs.com/)
icense ##
trap Copyright (c) 2012-2015 Terry Weiss & Contributors. All rights reserved.
ission is hereby granted, free of charge, to any person
ining a copy of this software and associated documentation
s (the "Software"), to deal in the Software without
riction, including without limitation the rights to use,
, modify, merge, publish, distribute, sublicense, and/or sell
es of the Software, and to permit persons to whom the
ware is furnished to do so, subject to the following
itions:
above copyright notice and this permission notice shall be
uded in all copies or substantial portions of the Software.
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
ESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
ERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
ERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
HER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
R DEALINGS IN THE SOFTWARE.