Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docpress #6

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Add docpress #6

wants to merge 8 commits into from

Conversation

dingo-d
Copy link
Member

@dingo-d dingo-d commented Feb 11, 2020

Added docpress as a default 'page' build for this repository. This generates a 'pretty' layout that is similar to what Tide has for their project.

@dingo-d dingo-d added the enhancement New feature or request label Feb 11, 2020
@dingo-d dingo-d self-assigned this Feb 11, 2020
@ernilambar
Copy link
Member

Looks like docpress needs to be installed globally to run docpress s. Could it be run from npm scripts?

@dingo-d
Copy link
Member Author

dingo-d commented Feb 26, 2020

I've updated the readme and package.json with scripts to run it locally, without global installation.

Copy link

@carolinan carolinan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't get it to work on Windows 10, I don't see any error messages, but it is not reading the correct readme file when "served" so it is not showing the requirements.
That does not mean it won't work on gitub pages, but I can't test it.

@dingo-d
Copy link
Member Author

dingo-d commented Mar 21, 2020

I'll try running this on my windows machine tomorrow.

@dingo-d
Copy link
Member Author

dingo-d commented Mar 23, 2020

On my windows machine, it runs fine, both start and builds, although I cannot see the docs in the sidebar, which is weird.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants