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

html docs could start on dc namespace #1103

Closed
gordonwoodhull opened this issue Feb 15, 2016 · 2 comments
Closed

html docs could start on dc namespace #1103

gordonwoodhull opened this issue Feb 15, 2016 · 2 comments
Labels
Milestone

Comments

@gordonwoodhull
Copy link
Contributor

It's okay to have html/dc.html be the start page, but it would be better if html/index.html went to the same place, because landing on a blank page is unnerving.

@gordonwoodhull gordonwoodhull added this to the v2.0 milestone Feb 15, 2016
@mtraynham
Copy link
Contributor

Not sure why it generates an empty index page in the first place... but let's do this instead.

Gordon, I'll let you make the change since it's basically a one-liner.

In Gruntfile.js:

        jsdoc: {
            dist: {
                src: [ '<%= conf.src %>/**/*.js', '!<%= conf.src %>/{banner,footer}.js'],
                options: {
                    destination: 'web/docs/html',
                    template: 'node_modules/ink-docstrap/template',
                    configure: 'jsdoc.conf.json'
                }
            }
        },

Change the src array to include the README.md file:
src: ['README.md', '<%= conf.src %>/**/*.js', '!<%= conf.src %>/{banner,footer}.js'],

This will convert the README markdown to a pretty nice index page.

@gordonwoodhull
Copy link
Contributor Author

Ok, cool, that works. I'll just add a welcome.md introducing the documentation.

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

No branches or pull requests

2 participants