@d-fischer/documen.ts
A TypeScript documentation viewer for use with [TypeDoc](https://github.com/TypeStrong/typedoc).
Last updated 7 days ago by d-fischer .
Original npm · Tarball · package.json
$ cnpm install @d-fischer/documen.ts 
SYNC missed versions from official npm registry.

Documen.ts

A TypeScript documentation viewer for use with TypeDoc.

ATTENTION: This application is still under initial development.

How to set up your documentation page

  1. In this early stage of the project, you still have to check out this project and make changes to it.
  2. In your own project root, execute this if you have typedoc globally installed (assuming your code is in the src/ folder):
    typedoc --json reference.json --mode file src
    
    • You can use jq -c to minify the JSON.
      typedoc --json referenceRaw.json --mode file src
      jq -c '.' referenceRaw.json > reference.json
      rm referenceRaw.json
      
    • You can also use the jq script that comes with this repository to pre-filter some unused data in order to save even more space.
      It includes filters for private and inherited members. If you don't want to filter these out, remove the respective filters from the script first.
      typedoc --json referenceRaw.json --mode file src
      jq -c -L path/to/this/repo/ 'import "filterDocs" as F; F::filterDocs' referenceRaw.json > reference.json
      rm referenceRaw.json
      
    • If you don't want to install typedoc globally, you can install it into your project as a devDependency and use node_modules/.bin/typedoc instead of typedoc on the command line.
  3. Put the generated reference.json file into src/Resources/data/ in this project.
  4. Proceed according to what you want to do:
    • For development of this application, run yarn && yarn run dev. A webpack-dev-server will start on port 3000.
    • For running this on a server with Node support, just put the whole contents of this directory on the server and execute yarn && yarn build && yarn run server on the server. An express server will start on port 8080.
      This has the benefit that a client does not need JavaScript enabled to show the documentation, as it uses React server rendering.
      • In both of the above cases, you can change the port the server runs on via the PORT environment variable.
    • If you don't need this benefit or don't have a server with Node support, run yarn && yarn run build-client and put the contents of the folder build/client on your server.
      The build script assumes the files to be served at the document root of your domain.

Current Tags

  • 0.4.10                                ...           latest (7 days ago)

27 Versions

  • 0.4.10                                ...           7 days ago
  • 0.4.9                                ...           a month ago
  • 0.4.8                                ...           a month ago
  • 0.4.7                                ...           a month ago
  • 0.4.6                                ...           a month ago
  • 0.4.5                                ...           a month ago
  • 0.4.4                                ...           a month ago
  • 0.4.3                                ...           a month ago
  • 0.4.2                                ...           a month ago
  • 0.4.1                                ...           a month ago
  • 0.4.0                                ...           a month ago
  • 0.3.0                                ...           3 months ago
  • 0.2.12                                ...           5 months ago
  • 0.2.11                                ...           5 months ago
  • 0.2.10                                ...           6 months ago
  • 0.2.9                                ...           6 months ago
  • 0.2.8                                ...           6 months ago
  • 0.2.7                                ...           6 months ago
  • 0.2.6                                ...           6 months ago
  • 0.2.5                                ...           6 months ago
  • 0.2.4                                ...           7 months ago
  • 0.2.3                                ...           7 months ago
  • 0.2.2                                ...           7 months ago
  • 0.2.1                                ...           7 months ago
  • 0.2.0                                ...           7 months ago
  • 0.1.1                                ...           7 months ago
  • 0.1.0                                ...           7 months ago
Maintainers (1)
Downloads
Today 0
This Week 11
This Month 25
Last Day 0
Last Week 14
Last Month 237
Dependencies (67)
Dev Dependencies (8)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |