EclipseFdn / asciidoc-wg.eclipse.org

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.
https://asciidoc-wg.eclipse.org/
Eclipse Public License 2.0
3 stars 10 forks source link
asciidoc hugo webdev

= asciidoc-wg.eclipse.org


NOTE

This project was migrated to Eclipse Gitlab on September 21, 2021.


The https://asciidoc-wg.eclipse.org website is generated with https://gohugo.io/documentation/[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.

=== Running a local preview of the site

Install dependencies, build assets and start a webserver:

[source,bash]

npm install && hugo server --destination=public

You can find guidance on the page-level metadata https://eclipsefdn-hugo-solstice-theme.netlify.app/[here], and examples of the assorted page types (components) https://eclipsefdn-hugo-solstice-theme.netlify.app/components/[here].

== Contributing

. https://help.github.com/articles/fork-a-repo/[Fork] the https://github.com/eclipsefdn/asciidoc-wg.eclipse.org[eclipsefdn/asciidoc-wg.eclipse.org] repository . Clone repository: git clone https://github.com/[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

== Related projects

=== https://github.com/EclipseFdn/solstice-assets[EclipseFdn/solstice-assets]

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

=== https://github.com/EclipseFdn/hugo-solstice-theme[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, https://github.com/eclipsefdn/asciidoc-wg.eclipse.org/issues/new[please open a new issue].

== Author

Christopher Guindon (Eclipse Foundation)

== Trademarks

== Copyright and license

Copyright 2021 the https://www.eclipse.org["Eclipse Foundation, Inc."] and the https://github.com/eclipsefdn/asciidoc-wg.eclipse.org/graphs/contributors[asciidoc-wg.eclipse.org authors]. Code released under the https://github.com/eclipsefdn/asciidoc-wg.eclipse.org/blob/main/LICENSE[Eclipse Public License Version 2.0 (EPL-2.0)].