documentationjs/documentation

beautiful, flexible, powerful js docs

Charles F. Munat

@chasm

I'm having real trouble documenting ES6 React/Redux code using pure functions. My sidebar ends up with a dozen mapStateToProps functions, for example. All efforts to use @module have been mixed at best. Is there a link to an example? Has anyone made this work? @typedef is also quite awkward. Am I missing something? TIA.

Jason Laster

@jasonLaster

hey @chasm we use @memberof https://github.com/devtools-html/debugger.html/blob/master/public/js/actions/sources.js#L53-L56

Erik Arvidsson

@arv

@chasm --document-exported might be more suitable since it only documents bindings that have been explicitly exported.

Peter Street

@LazerFX

I've raised issue #559. I'd like to assist in sorting it out, but I've no experience debugging npm modules. If you can point me in the right direction, I'm sure I can assist :)

Benjamin Lupton

@balupton

Hey everyone, where is the best place to get started on documentationjs/documentation#577

Fernando Montoya

@montogeek

How to use Flow types? I mean, it is there a flag or documentation will automatically do it by checking // @flow comment?

Fernando Montoya

@montogeek

Hi @tmcw
If I want to create docs from the following code:

type CaptureEmail = {
  email: string,
  url: string,
}
const Engage = {
  /**
   * Captures users email upon leaving booking page
   */
  captureEmail: (data: CaptureEmail): Promise<CaptureEmail> => {
  }
}

Do I need latest master changes?

Gajus Kuizinas

@gajus

Hello

Whats the best practise to document helpers functions?

Consider this documentation http://8e3aa602.ngrok.io/

http://8e3aa602.ngrok.io/#iscookieset

This is a function thats used internally, ./src/utilities/isCookieSet.

Having it here without any context makes little sense.

Is there a way to at least group them under some namespace "utilities"?

Happy-Ferret

@Happy-Ferret

Does documentation support .js.flow files?

Happy-Ferret

@Happy-Ferret

More specifically, does it even support flow declarations? Can't seem to get these to work.

Tom MacWright

@tmcw

Whew, long time no in this channel. But no longer

Tom MacWright

@tmcw

update of yesterday's progress: http://www.macwright.org/2017/04/11/day-2.html

Tom MacWright

@tmcw

okay, first order of business, prettier 1.0.0

Tom MacWright

@tmcw

destructuring parameters are tricky!

David Halls

@davedoesdev

In documentation.yml, how do I specify doc items? I'm getting an error: "Table of contents defined sorting of centro.separate_auth but no documentation with that namepath was found"

I've tried "separate_auth" too which is what documentation generates in the output

David Halls

@davedoesdev

if (!comment.memberof && indexes[comment.name] !== undefined) {

Seems only items which aren't members of a namespace are considered

David Halls

@davedoesdev

jest doesn't seem to be running the fixture *.input.js tests

Oscar Dub

@odub

hey just to say thanks for the project!

i'm happy with how my heavily hacked documentation.js site came out:
mpe.js.org

Prateek Saxena

@prtksxna

@odub That looks really neat

Oscar Dub

@odub

:tada: thanks!

Prateek Saxena

@prtksxna

:+1:

Prateek Saxena

@prtksxna

Is there a way to add a markdown section without a name? For example, I want the README.md to be the first section in doc.yml, but don't want an extra name: since the .md already has an h1.

Prateek Saxena

@prtksxna

It seems github activity doesn't show up here any more.

tmcw: Is this still the correct place to discuss documentation.js?

@tmcw ^

Prateek Saxena

@prtksxna

Hmm https://macwright.org/2017/06/06/documentation-js.html

Prateek Saxena

@prtksxna

I keep getting an Error: EISDIR: illegal operation on a directory, open 'docs' when I try to build the documentation using an external theme

@odub Di you see this too?

It works well if I use the default theme

Oscar Dub

@odub

i use a modded version of the default theme

Prateek Saxena

@prtksxna

@odub Hmm, the default theme being the one here - (https://github.com/documentationjs/documentation/tree/master/src/default_theme

@odub or https://github.com/documentationjs/documentation-theme-default/

I also want to keep the theme 'external' in that it'll be a separate npm dependency, I'll be calling it like documentationjs buil…-t node_modules/my-theme/ -o docs

James

@aretecode

@odub nice site output :-)

Wybe

@wvbe

Aloha everyone

It seems @const some-variable-name-with-dashes gets parsed to an object with name simply “some”. Does anyone know if this is standard JSDoc, or something in documentationjs?

"tags": [
      {
        "title": "const",
        "description": “-variable-name-with-dashes",
        "lineNumber": 3,
        "type": null,
        "name": “some"
      }
}

Wybe

@wvbe

Does anyone know if documentationjs can be used with JSDoc plugins?

Dimitri KOPRIWA

@kopax

Hi, I am using documentationjs for generating markdown from JSdoc, I have written in the jsdoc [val=true] next to my boolean, I expect to have it rendered so it is nicely displayed as default option. Instead, I have [val=true] (the same), and it does not look nice in markdown. Is this how we generate default in JSdom?

Where communities thrive

People

Repo info

Activity