Skip to content
🌐 website for ethclassic documentation and dev blogging
JavaScript CSS Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
docs
website
.dockerignore
.gitignore
BUILDING.md
CONTRIBUTING.md
CONVENTIONAL_COMMITS.md
Dockerfile
LICENSE.md
README.md
RELEASING.md
VERSIONING.md
docker-compose.yml

README.md

Ethereum Classic Technical Documentation

Chat on Discord

Ethereum Classic Docs

A website for classic EthereumStack developers.
View Demo · Report Bug · Request Feature

Table of Contents

About The Project

This project is an open-source technical documentation resource for classic EthereumStack developers. This solution is live at https://docs.ethereumclassic.org. Everyone is welcomed to contribute to this project simply see CONTRIBUTING for contributing guidance.

Getting Started

This project uses the Docusaurus website generator. The src branch contains the source files, and gh-pages is the deployed build.

Prerequisites

Installation

Install docusaurus on your machine. Need help?

Run local build

To run the website locally run npm start in the website/ directory. Changes will be seen in realtime at http://localhost:3000/. If changes are not shown just npm start again.

Usage

Clone your fork of this repository. Ensure you're working in the src branch. The src contains two key directories, website/ and docs/.

  • docs/ contains Markdown documentation files.
  • website/ site configuration, static assets, and page components.
  • website/blog contains blog posts.

Contribute a blog post.

Fork the repo, create your blog post as a Markdowwn file in website/blog, and submit a Pull Request. Use existing posts as a reference, however your post should meet the following minimum requirements.

  • At the heading of your Markdown file. Please input article title, author name, and author url (twitter link).
    ---
    title: INPUT ARTICLE TITLE
    author: INPUT AUTHOR NAME
    authorURL: INPUT AUTHOR URL (TWITTER LINK)
    ---
  • Name the markdown file like so YEAR-MM-DD-TITLE.md, 2020-02-24-etc-to-the-moon.md.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

License

Apache License 2.0

Resources

You can’t perform that action at this time.