eclipsefdn-hugo-solstice-theme

    0.0.139 • Public • Published

    hugo-solstice-theme

    The official Hugo theme from the Eclipse Foundation.

    Getting Started

    Dependencies:

    Program Version
    node.js ~ 12.22.0
    npm ~ 7.11
    Hugo > 0.76
    Git > 2.31
    Make > 4.3

    Install dependencies, build assets and start a webserver:

    make run

    To run yarn watch and hugo server at the same time:

    In one terminal:

    yarn run watch

    Once above process is done, in another terminal:

    make run

    Getting Started (Windows)

    To install our dependencies on Windows, replace the previous npm install with this one:

    set NODE_ENV=production && npm install

    Alternative Solution

    Install win-node-en globally and then install our dependencies by following the steps from our Getting Started section.

    yarn add -g win-node-env

    Known Issues

    Versions of Hugo 0.60 and beyond do not support raw HTML in markdown files by default. To enable this feature, unsafe HTML rendering can be enabled in the Goldmark engine in the site configuration. This is not recommended as it exposes rendered content vulnerable to injected content on the site.

    Contributing

    1. Fork the solstice-assets repository
    2. Clone repository: git clone https://gitlab.eclipse.org/[your_github_username]/hugo-solstice-theme.git
    3. Create your feature branch: git checkout -b my-new-feature
    4. Commit your changes: git commit -m 'Add some feature' -s
    5. Push feature branch: git push origin my-new-feature
    6. Submit a merge request

    Documentation

    Bugs and Feature Requests

    Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

    Author

    Christopher Guindon (Eclipse Foundation)

    Trademarks

    • Jakarta and Jakarta EE are Trademarks of the Eclipse Foundation, Inc.
    • Eclipse® is a Trademark of the Eclipse Foundation, Inc.
    • Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.

    Copyright and License

    Copyright 2018-2021 the Eclipse Foundation, Inc. and the hugo-solstice-theme authors. Code released under the Eclipse Public License Version 2.0 (EPL-2.0).

    Keywords

    none

    Install

    npm i eclipsefdn-hugo-solstice-theme

    DownloadsWeekly Downloads

    95

    Version

    0.0.139

    License

    EPL-2.0

    Unpacked Size

    369 kB

    Total Files

    233

    Last publish

    Collaborators

    • ericpoirier
    • chrisguindon