94 Commits

Author SHA1 Message Date
Jeff Williams
1305499207 chore: use Prettier to format source files 2021-09-19 13:20:31 -07:00
Misha Brukman
c865547cd6
Add links to CONTRIBUTING.md and LICENSE [skip ci] (#1748)
This makes it easier to access these files by simply clicking on the
relevant name in the README.md file, rather than having to scroll up to
the file list and manually finding the relevant file being discussed.
2021-06-02 14:39:58 -07:00
Jeff Williams
9294f2fcf8 chore: use GitHub Actions build-status badge 2020-12-24 13:20:49 -08:00
André Storhaug
4dc173ecf4
Add link to jsdoc-action GitHub Action in the README file (#1745) 2020-02-24 22:22:50 -08:00
Jeff Williams
ac89505b56 docs: remove instructions for installing development version
This command no longer works now that the `jsdoc` package is in a `packages/jsdoc` subdirectory.

Fixes #1714.
2019-10-20 19:53:16 -07:00
Jeff Williams
85581b8a84 3.6.3 2019-07-14 10:50:53 -07:00
Jeff Williams
5fa9d1ac11 Update license info in README. 2019-05-12 15:12:45 -07:00
Jeff Williams
b8012f482d Update dependencies, plus the URLs for the GitHub repos and docs. 2019-05-04 16:04:57 -07:00
Wojciech Krysiak
10c004f823 update docs with new template (#1604) 2019-01-20 10:46:34 -08:00
Jeff Williams
7b304d8042 update dependencies and supported Node.js versions
We also need to migrate from `babylon`, but that'll take more work, which is tracked in jsdoc3/jsdoc#1598.
2019-01-12 14:32:17 -08:00
Jeff Williams
8f2322f77c add Slack channel to README 2017-07-13 20:47:05 -07:00
greenkeeper[bot]
827bcc33b5 Update dependencies to enable Greenkeeper 🌴 (#1405) 2017-07-13 11:14:49 -07:00
Jeff Williams
5080ec75bc add tools to README (#1353) 2017-07-12 17:10:18 -07:00
Jeff Williams
ec7ac85ecb improve installation instructions and reformat 2017-07-12 16:17:46 -07:00
이민규
b4a5b90025 add tui-jsdoc-template to README (#1300) 2017-07-03 19:02:17 -07:00
Jeff Williams
0bd249ab83 update supported Node.js version
Babylon requires Node.js 4.2.0 or later, so JSDoc does too.
2017-07-01 21:14:48 -07:00
Jeff Williams
dd905a2617 remove obsolete links (#1336) 2017-03-10 16:32:56 -08:00
Michael Kühnel
24bc2bceb8 Add missing space 2016-11-11 16:26:09 +01:00
i52
3a956fd271 Add example for docdash 2016-06-05 12:42:33 +02:00
Jeff Williams
622c7dcc73 Merge pull request #1131 from mlucool/master
Update README.md to include gulp task
2016-03-21 16:21:12 -07:00
Jeff Williams
7b46afd590 Merge pull request #1147 from pra85/2016
Update license year range to 2016
2016-03-21 15:58:23 -07:00
clenemt
3c2493a72d Add docdash to available templates
If you are ever interested in another template you can merge this in :)
2016-02-29 16:37:19 +01:00
Prayag Verma
13defb857e Update license 2016-01-19 01:02:41 +05:30
mlucool
23dad61d13 Update README.md to include gulp task 2015-12-20 08:47:01 -05:00
Luke Page
ba59b32579 Change URL for where docstrap now lives 2015-12-07 08:13:11 +00:00
Tim Schaub
621f012211 Remove Rhino support 2015-10-30 13:11:43 -06:00
Dan Dascalescu
5d4d250431 Direct link to Travis build image 2015-07-30 01:22:54 -07:00
Jeff Williams
f628ee128c minor README fixes 2015-05-10 18:41:14 -07:00
Nijiko Yonskai
be449a60f7 feat(Readme): Add minami template to README.md 2015-03-24 21:33:28 -07:00
Jeff Williams
3c7f54f749 move font stuff to the correct README 2015-01-06 19:38:34 -08:00
Jeff Williams
7761292b97 use nicer typography in the default template (#780)
Squashed commit of the following:

commit eb310340ae542152ae5fd15b070e389a17b71913
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 17:24:19 2014 +0000

    Updated to use the same set of monospace typefaces as MDN too.

commit 5ff2591f8c3711e20f87eeb2e41347396d201414
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 17:15:28 2014 +0000

    Add font re-generation instructions to the README.

commit bb4502a308936a31684732104b09ae737e6fbaec
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 16:11:06 2014 +0000

    Added additional variations of the OpenSans typeface.

commit 125f2c91e767c7fa853ffa3222e7ed7d02f027b8
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 15:33:44 2014 +0000

    Moved the web fonts into a separate 'fonts' directory.

commit 968998c677a946e79910b96cff2cb4c29898eb48
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 15:24:46 2014 +0000

    Removed a negative margin hack we no longer seem to need.

commit 82f96d67cd3067ba6fd3deadee13e8853eb58491
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 15:13:15 2014 +0000

    Removed the 'Summary' heading, plus re-jigged the formatting so there isn't too much space before the content.

commit db9dfad5c2339ea6d36a400b59da0447d446920d
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 14:23:05 2014 +0000

    Fix for styling that was incorrectly being applied to each item in a list, rather than to the list itself.

commit 774271bd4e74ea429df7e5ae8fb9473097b81a1b
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 14:14:04 2014 +0000

    For consistency, ensure there is always a space after the colon used to delimit CSS rule pairs.

commit 88d59794b0442e594bedf6fb17a638923ac67c2a
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 14:07:31 2014 +0000

    Replace tabs with spaces to be consistent with the remainder of the stylesheet.

commit 37e5043403441a19cbe0cf2e2f4dec8ceba6cacb
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 14:02:34 2014 +0000

    Use the same color for headings that MDN does.

commit 8f925659efd7a6c9996bf2a8dcebb174f79dc8d8
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Fri Aug 22 09:46:41 2014 +0100

    Accidentally missed from previous check-in.

commit e98b060822b018c1403b98c92400052565d69e20
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Fri Aug 22 09:46:11 2014 +0100

    Updated the license to reflect the inclusion of the Open Sans typeface,
    plus included EOT and SVG versions of the font so that older version of
    IE and Android browser also get to see the page rendered correctly.

commit 7e1a581bca931603e738e5afc238e7f211c9d444
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Thu Aug 21 14:32:02 2014 +0100

    Rebased the template typography off of the Mozilla Developer Network
    site so generated API docs have a more contemporary and familiar style.
2014-11-05 16:48:09 -08:00
Jeff Williams
612b96c2cb remove obsolete note from README 2014-10-09 14:24:45 -07:00
Jeff Williams
4839915cec the mailing list is back! 2014-06-28 08:53:40 -07:00
Jeff Williams
fa57a07c6b refer questions to Stack Overflow until the mailing list is fixed 2014-06-14 07:58:25 -07:00
Jeff Williams
3242a5de52 fancy new Travis CI badge 2014-03-27 08:26:04 -07:00
Jeff Williams
f9e36811ae add links to 3rd-party templates; update copyright 2014-03-12 09:26:38 -07:00
Jeff Williams
48e6c392d5 huge whitespace cleanup
- remove all trailing whitespace
- for consistency, replace all tabs with spaces
2014-03-03 07:43:01 -08:00
Jeff Williams
6d62a114bf fix line break 2014-02-12 08:54:21 -08:00
Jeff Williams
4f8e9fb5dc don't use npm to install the Rhino version (#577) 2014-02-10 21:14:43 -08:00
Jeff Williams
e007f71c86 typo 2014-01-31 08:08:23 -08:00
Jeff Williams
1c0c06f588 explain npm permissions issue and solution (#572) 2014-01-31 08:07:33 -08:00
Jeff Williams
28b467f3a8 punctuation 2014-01-25 20:57:31 -08:00
Nick Schonning
90f8efe7e9 Add link to Grunt plug-in 2014-01-06 01:06:38 -05:00
Jeff Williams
e4b97bf6ba add the supported Node.js version 2013-12-26 10:17:08 -08:00
Jeff Williams
405ebb5c3b fix typo; clarify Node.js instructions 2013-12-20 11:09:47 -08:00
Jeff Williams
1670745352 fix npm syntax 2013-11-04 21:32:28 -08:00
Jeff Williams
95338341a8 update installation/usage instructions 2013-11-04 21:22:57 -08:00
Jeff Williams
de4297b20b refactor jsdoc.js; update Rhino
- Switched to a new Rhino fork: https://github.com/jsdoc3/rhino
  (currently reflects mozilla/rhino HEAD + enhancements for JSDoc)
- Removed jsdoc/util/global; new Rhino fork provides a `global` alias
  just like Node.js
- Moved most of jsdoc.js into cli.js, and refactored for clarity
2013-10-27 10:46:27 -07:00
cgwyllie
c236bf955f Update README.md
Changed clone URL for repo to HTTPS read-only so it doesn't require keypair access.
2013-08-01 10:05:02 +01:00
Jeff Williams
609c9c5910 update README 2013-04-16 08:45:27 -07:00