asciidoc-wg.eclipse.org

The https://asciidoc-wg.eclipse.org website is generated with Hugo.

The AsciiDoc Working Group drives the standardization, adoption, and evolution of AsciiDoc. This group encourages and shapes the open, collaborative development of the AsciiDoc language and its processors.

Getting started

Prerequisites

The following pre-requisites are necessary to create a local preview of the site. If you only want to change content without a local preview, only a text editor is necessary to change content.

Node and NPM (LTS 14.x) to install resources and dependencies - see https://nodejs.org/
Hugo to render site from templates and content - see https://gohugo.io/
Asciidoctor to transform AsciiDoc content to HTML - see https://asciidoctor.org/

Running a local preview of the site

Install dependencies, build assets and start a webserver:

npm install && hugo server --destination=public

You can find guidance on the page-level metadata here, and examples of the assorted page types (components) here.

Contributing

Fork the eclipsefdn/asciidoc-wg.eclipse.org repository
Clone repository: git clone your_github_username/asciidoc-wg.eclipse.org.git
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -m 'Add some feature' -s
Push feature branch: git push origin my-new-feature
Submit a pull request

Declared Project Licenses

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at https://www.eclipse.org/legal/epl-2.0.

SPDX-License-Identifier: EPL-2.0

EclipseFdn/solstice-assets

Images, less and JavaScript files for the Eclipse Foundation look and feel.

EclipseFdn/hugo-solstice-theme

Hugo theme of the Eclipse Foundation look and feel.

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.

lightguard / asciidoc-wg.eclipse.org Goto Github PK