Skip to content

Move docs to github pages #864

@Steveb-p

Description

@Steveb-p

Documentation in current form, while works great, requires traversing "source code" of repository. It might be beneficial to use gh-pages to show documentation only.

It should be little cost to enable it. As a matter of fact, @makasim you can already do so in repository settings by going to https://github.com/php-enqueue/enqueue-dev/settings and choosing /docs from master as gh-pages source. Conveniently .md files can be used and Github uses Jekyll to build the site.

image

I've taken the liberty and enabled it on my own repository and added a custom theme, which allows creating sidebar menu (for a relatively complex docs structure should be a nice addition - see 2. refence below). Link to template is available so you can see if "white" colour scheme is more to your liking.

See: https://steveb-p.github.io/enqueue-dev/

References:
https://help.github.com/en/articles/user-organization-and-project-pages
https://pmarsceill.github.io/just-the-docs/

When enabled, gh-pages will show under:
https://enqueue-php.github.com/enqueue-dev
(unless you make a organization repository names enqueue-php)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions