Ethereum Classic Technical Documentation
Ethereum Classic Docs
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.
This project uses the Docusaurus website generator. The
src branch contains the source files, and
gh-pages is the deployed build.
- Docusaurus, read the docs at https://docusaurus.io/docs/en/
- Node >= 8.x and/ or Yarn >= 1.5.
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.
Clone your fork of this repository. Ensure you're working in the
src branch. The
src contains two key directories,
docs/contains Markdown documentation files.
website/site configuration, static assets, and page components.
website/blogcontains 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
See the open issues for a list of proposed features (and known issues).
Apache License 2.0