TOC not generating #169

cvax · 2016-10-02T17:02:21Z

I am not sure what the issue is, but I can't get it to generate the TOC as described in your usage instructions. I setup a super simple test over here: https://github.com/cvax/docpresstest
I am on docpress 0.7.0 and Windows 7.

When I serve this page it generates the root README.md just fine, but it doesn't build any of the TOC's README.md in /docs folder. I also tried to clone one of your showcase's docs to try serving, same result. Root README.md works, but TOCs didn't build.

Is this a docpress installation issue? Perhaps Windows issue? I just installed the npm package globally. There were some npm deprecated warnings on minimatch, native-or-bluebird, and fsevents though.

knownasilya · 2016-11-01T15:06:10Z

Try installing it locally in the project you're trying to build.

cvax · 2016-11-01T15:50:57Z

I just tried this, but same results. No TOC with chapters built.
I am on Node 6.9.1 with docpress 0.7.1.

npm uninstall docpress -g
npm install docpress
docpress serve

I also tried

npm init
npm install --save-dev --save-exact docpress
docpress serve

They build the page, but the generated TOC has nothing from my /docs/README.md and is blank.

knownasilya · 2016-11-01T16:40:10Z

Looks to be working fine with your sample repo:

Most likely a windows issue.

cvax · 2016-11-01T17:23:39Z

Mind if I ask what environment you are using? On my end the left side just says "My project" with nothing underneath.

knownasilya · 2016-11-01T17:27:42Z

I'm on OSX. I'm going to mark this as a bug.

The issue is probably here https://github.com/docpress/docpress-core/blob/master/lib/tocify.js#L219

Possible fix for docpress/docpress#169

cvax · 2016-11-02T04:02:49Z

Thanks.

FYI. I just tried this on Windows 10's Linux Subsystem and this is what I got.

cvax@U36SG-DP:/mnt/c/Users/cvax/Desktop/docpresstest$ docpress s
  Docpress
  starting development - ^C to exit

   395ms    first build
    ✓ on    livereload
    ✓ on    http://localhost:3000

            Running
events.js:160
      throw er; // Unhandled 'error' event
      ^

Error: watch /mnt/c/Users/cvax/Desktop/docpresstest EPERM
    at exports._errnoException (util.js:1026:11)
    at FSWatcher.start (fs.js:1429:19)
    at Object.fs.watch (fs.js:1456:11)
    at createFsWatchInstance (/mnt/c/Users/cvax/Desktop/docpresstest/node_modules/chokidar/lib/nodefs-handler.js:37:15)
    at setFsWatchListener (/mnt/c/Users/cvax/Desktop/docpresstest/node_modules/chokidar/lib/nodefs-handler.js:80:15)
    at FSWatcher.NodeFsHandler._watchWithNodeFs (/mnt/c/Users/cvax/Desktop/docpresstest/node_modules/chokidar/lib/nodefs-handler.js:228:14)
    at FSWatcher.NodeFsHandler._handleDir (/mnt/c/Users/cvax/Desktop/docpresstest/node_modules/chokidar/lib/nodefs-handler.js:407:19)
    at FSWatcher.<anonymous> (/mnt/c/Users/cvax/Desktop/docpresstest/node_modules/chokidar/lib/nodefs-handler.js:455:19)
    at FSWatcher.<anonymous> (/mnt/c/Users/cvax/Desktop/docpresstest/node_modules/chokidar/lib/nodefs-handler.js:460:16)
    at FSReqWrap.oncomplete (fs.js:123:15)

Kikobeats · 2016-11-21T09:58:35Z

@cvax did you try the current PR that resolve the problem?

cvax · 2016-11-21T17:07:10Z

@Kikobeats Sorry, just gave it a shot now. This is what I got with that PR in docpress-core.

 docpress serve

  Docpress
  starting development - ^C to exit

   err ✗    first build
    ✓ on    livereload
    ✓ on    http://localhost:3000

            Running

  ✗ docs\README.md: Unknown reference '../README.md'
    at fix (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\docpress-core\lib\fix_html.js:64:13)
    at Object.<anonymous> (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\docpress-core\lib\fix_html.js:41:29)

    at initialize.exports.each (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\cheerio\lib\api\traversing.js:300:24)
    at fixReferences (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\docpress-core\lib\fix_html.js:39:22)
    at fixHtml (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\docpress-core\lib\fix_html.js:15:3)
    at m (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\docpress-core\lib\index.js:241:7)
    at memoize (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\docpress-core\lib\memoize.js:19:15)
    at each (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\docpress-core\lib\index.js:239:15)
    at C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\lodash\_createBaseFor.js:17:11
    at baseForOwn (C:\Users\cvax\AppData\Roaming\nvm\v6.9.1\node_modules\docpress\node_modules\lodash\_baseForOwn.js:13:20)

Without that PR it would build, but no TOC. I tried changing the path, but anything I put in was giving this error.

knownasilya · 2016-11-21T17:11:39Z

Looks like a path issue still exists..

cvax · 2016-11-21T18:04:22Z

@knownasilya ya, looks like there are still some Windows incompatible pathing coded into fix_html.js. Believe that might be the problem.

bendulum · 2016-12-05T14:50:01Z

Same issue for me, ToC is not created. Using Windows 10.
No errors in the console.
node 7.0.0
npm 3.10.8
docpress 0.7.1

cvax · 2016-12-23T16:37:53Z

@knownasilya @Kikobeats just wanted to ask if there was any other info you might need to potentially address this. Thanks.

Kikobeats · 2016-12-23T16:49:44Z

actually I don't know

knownasilya · 2016-12-23T18:24:58Z

I had issues debugging with node debug .., @rstacruz is there a trick to debug?

rstacruz · 2016-12-23T20:12:02Z

Sorry mate, never tried it. :(

rstacruz · 2016-12-23T20:14:48Z

I think I know what's up here. Docpress keeps a list of files like so:

/* _docpress.json */
{
  sources: {
    'README.md': ...
    'intro/index.md': ...
  }
}

These are generated from docpress-core, and it assumes posix-style /slash/delimited/paths. Unfortunately there are many places that assume this :\

cvax · 2016-12-27T19:39:02Z

@rstacruz Running from Win10 Linux Subsystem has the posix paths though. Maybe the issue on that Linux Subsystem is different than the issue on regular Windows.

jasondavis · 2017-01-05T01:05:35Z

anyone get this working on windows yet?

thedaviddias · 2017-08-30T02:41:12Z

I have the same issue on MAC OSX 10.11.6, Node v7.1.0

celroid · 2019-09-17T23:07:56Z

On windows I downloaded the sources of the docpress project itself and when I tried to generate the docs I got the same error.
✗ README.md: Unknown reference 'docs/showcase.md'

sushanpth · 2020-05-10T02:51:31Z

I used docpress for https://github.com/namedframework/docs and worked fine from Mac few years back. Working documentation is at https://docs.namedframework.com/

I am trying to update same documentation now on Windows system and TOC is not generating.

OS: Windows 10 (Version 1909)
node: v12.16.3
docpress: v0.8.1

knownasilya added the bug label Nov 1, 2016

knownasilya added a commit to docpress/docpress-core that referenced this issue Nov 1, 2016

Use path.join for toc source

1f9d6a0

Possible fix for docpress/docpress#169

knownasilya mentioned this issue Nov 1, 2016

[WIP] Use path.join for toc source docpress/docpress-core#137

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TOC not generating #169

TOC not generating #169

cvax commented Oct 2, 2016

knownasilya commented Nov 1, 2016

cvax commented Nov 1, 2016 •

edited

knownasilya commented Nov 1, 2016 •

edited

cvax commented Nov 1, 2016

knownasilya commented Nov 1, 2016

cvax commented Nov 2, 2016

Kikobeats commented Nov 21, 2016

cvax commented Nov 21, 2016

knownasilya commented Nov 21, 2016

cvax commented Nov 21, 2016

bendulum commented Dec 5, 2016

cvax commented Dec 23, 2016

Kikobeats commented Dec 23, 2016

knownasilya commented Dec 23, 2016

rstacruz commented Dec 23, 2016 via email •

edited

rstacruz commented Dec 23, 2016

cvax commented Dec 27, 2016

jasondavis commented Jan 5, 2017

thedaviddias commented Aug 30, 2017

celroid commented Sep 17, 2019

sushanpth commented May 10, 2020 •

edited

TOC not generating #169

TOC not generating #169

Comments

cvax commented Oct 2, 2016

knownasilya commented Nov 1, 2016

cvax commented Nov 1, 2016 • edited

knownasilya commented Nov 1, 2016 • edited

cvax commented Nov 1, 2016

knownasilya commented Nov 1, 2016

cvax commented Nov 2, 2016

Kikobeats commented Nov 21, 2016

cvax commented Nov 21, 2016

knownasilya commented Nov 21, 2016

cvax commented Nov 21, 2016

bendulum commented Dec 5, 2016

cvax commented Dec 23, 2016

Kikobeats commented Dec 23, 2016

knownasilya commented Dec 23, 2016

rstacruz commented Dec 23, 2016 via email • edited

rstacruz commented Dec 23, 2016

cvax commented Dec 27, 2016

jasondavis commented Jan 5, 2017

thedaviddias commented Aug 30, 2017

celroid commented Sep 17, 2019

sushanpth commented May 10, 2020 • edited

cvax commented Nov 1, 2016 •

edited

knownasilya commented Nov 1, 2016 •

edited

rstacruz commented Dec 23, 2016 via email •

edited

sushanpth commented May 10, 2020 •

edited