Skip to content

Commit

Permalink
Document all options
Browse files Browse the repository at this point in the history
... quite a few were missing.
Also adds heading links and a TOC on each page.
  • Loading branch information
Gerrit0 committed Jan 10, 2020
1 parent 2cb092e commit 5a100f8
Show file tree
Hide file tree
Showing 13 changed files with 603 additions and 236 deletions.
9 changes: 7 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ GEM
ethon (0.12.0)
ffi (>= 1.3.0)
eventmachine (1.2.7)
eventmachine (1.2.7-x64-mingw32)
execjs (2.7.0)
faraday (0.15.4)
multipart-post (>= 1.2, < 3)
ffi (1.10.0)
ffi (1.10.0-x64-mingw32)
forwardable-extended (2.6.0)
gemoji (3.0.0)
github-pages (193)
Expand Down Expand Up @@ -207,6 +209,8 @@ GEM
multipart-post (2.0.0)
nokogiri (1.10.1)
mini_portile2 (~> 2.4.0)
nokogiri (1.10.1-x64-mingw32)
mini_portile2 (~> 2.4.0)
octokit (4.13.0)
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.2)
Expand Down Expand Up @@ -240,14 +244,15 @@ GEM

PLATFORMS
ruby
x64-mingw32

DEPENDENCIES
github-pages
jekyll-redirect-from
minima

RUBY VERSION
ruby 2.5.3p105
ruby 2.6.5p114

BUNDLED WITH
1.17.1
1.17.2
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# TypeDoc homepage
Holds the contents of http://typedoc.org.
Holds the contents of https://typedoc.org.
GitHub pages renders the website from the `gh-pages` branch using [Jekyll](https://jekyllrb.com/).

## Reporting Issues
Please report issues to the [TypeStrong/typedoc](https://github.com/TypeStrong/typedoc) repo for better visibility.

## Writing guides
Guides are stored in the `_guides/` directory and written in Markdown. Each file should contain the following header section for Jekyl with an appropriate title and menu order.
Guides are stored in the `_guides/` directory and written in Markdown. Each file should contain the following header section for Jekyll with an appropriate title and menu order.

```
---
Expand Down
216 changes: 0 additions & 216 deletions _guides/arguments.md

This file was deleted.

9 changes: 9 additions & 0 deletions _guides/doccomments.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,15 @@ Keeps the subsequent code from being documented.
function doSomething(target: any, value: number): number;
```

### ```@internal```
Marks the following code as internal.
If the TypeScript `--stripInternal` compiler flag is passed, TypeDoc will not document the given code.

```typescript
/** @internal */
export const secret = 1122;
```

### ```@category```
Allows grouping reflections on a page

Expand Down
15 changes: 3 additions & 12 deletions _guides/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,7 @@ menuOrder: 1

# Installation

<ul class="toc">
<li><a href="#installation">Installation</a></li>
<li><a href="#command-line-interface">Command line interface</a></li>
<li><a href="#node-module">Node Module</a></li>
<li><a href="#third-party-tools">Third-Party Tools</a></li>
</ul>

## Installation

### Requirements
## Requirements

TypeDoc requires [Node.js](http://nodejs.org/) to be installed on your system. If you haven't done that already, head
over to their site and follow their install instructions.
Expand All @@ -24,7 +15,7 @@ Installing TypeDoc is available as a node package. Using ``npm`` ensures that al
dependencies are setup correctly. You can choose to either install locally to your project or
globally to the CLI.

### Local installation (preferred)
## Local installation (preferred)

If you want to use TypeDoc from your command line in a project, use the API in your project code, or TypeDoc in an npm script, a local installation is the recommended approach. First install TypeDoc locally in your project:

Expand All @@ -44,7 +35,7 @@ TypeDoc 0.13.0
Using TypeScript 3.1.1 from /Users/aciccarello/Documents/code/typedoc/typedoc/node_modules/typescript/lib
```

### Global CLI installation
## Global CLI installation

Like the TypeScript compiler or any other NPM module that has an executable, TypeDoc's executable can be called from anywhere if you
install TypeDoc as a global module. Note that this is not the preferred approach in the event that different projects need different versions of TypeDoc. If you follow the global approach, you may eventually run into the problem
Expand Down
Loading

0 comments on commit 5a100f8

Please sign in to comment.