Add an index page containing all symbols

[sebastian-lenz]

This demand has been raised by Daniel in #70. Still have no clue where it should live in the navigation and how it should look like.

[balupton]

What about the sidebar? As right now, when someone generates their documentation, the viewer of the documentation needs to know to look in the sidebar, and go click crazy to get everything. If the sidebar contained everything, then the documentation becomes more accessible to the user as the navigation becomes more obvious and immediate.

Would also knock off #182

[balupton]

Actually seems http://typedoc.org/api/index.html already has this. But for some reason, locally I do not:

"our:meta:docs": "typedoc --exclude '**/*test*' --name \"$npm_package_name\" --readme ./README.md --out ./docs ./source",

and my tsconfig as I'm using babel

{
  "compilerOptions": {
    "target": "esnext",
    "moduleResolution": "node",
    "allowJs": true,
    "noEmit": true,
    "strict": true,
    "isolatedModules": true,
    "esModuleInterop": true
  },
  "include": [
    "source"
  ]
}

produces when opening index.html directly (which unbeknownst to me at the time disables search)

or when accessed directly via a local server (which reenables search)

clicking "index" which isn't intuitive, eventually gets me the definition of eachr, and a link to IteratorCallback

Which requires a click on IteratorCallback to get its details:

Requiring 3 clicks for the user to hopefully access the full documentation.

[Gerrit0]

The sidebar behavior depends on the "mode" option, try setting it to "file" with --mode file

[balupton]

The sidebar behavior depends on the "mode" option, try setting it to "file" with --mode file

Where are the modes documented? As --mode doesn't exist at http://typedoc.org/guides/usage/

[Gerrit0]

The TypeDoc site is horribly out of date at the moment. @aciccarello is working on updating it and pulling it into the main repo on the add-docs branch, which should help prevent this from happening again.

The mode option is documented in the readme, and in the --help output. It should also be added to the site guides once the add-docs branch is merged.

[balupton]

No worries. Thanks for the update.

In case it helps: For the @bevry packages we are in the process of moving all our hand written docs to gitbook and redirecting our websites there. Even for @docpad, a static site generator which website is currently DocPad will also be moved to gitbook. As our time is so limited for open source work it is more effective and meaningful for us to focus purely on the libraries and docs, rather than the boilerplate for them. Perhaps move the website to gitbook (they support custom domains), then move the docs from the readme to it, so the readme just has a link to gitbook.

_{Sent with GitHawk}

[balupton]

Why was this closed?

[Gerrit0]

I was cleaning up issues which have had very little interest expressed in them + no activity in a couple years, I figured if anyone cared about them, they'd ask why they were closed and I could reopen :)

In this case, I also think that this request is mostly obsolete with the work done in 0.20. In 0.20 TypeDoc asks the compiler for exported symbols and only documents those. If you only provide one entry point, then the sidebar will include those exported symbols directly. (Example: In @bevry/list, npm i typedoc@beta, npx typedoc source/index.ts produces:

If there is a namespace, symbols inside those namespace aren't shown until you go to the namespace... which seems reasonable to me.