Skip to content
This repository has been archived by the owner on Jul 16, 2021. It is now read-only.

Latest commit

 

History

History
129 lines (98 loc) · 4.01 KB

README.md

File metadata and controls

129 lines (98 loc) · 4.01 KB
Raw

Collaborative Etiquette MIT

Description

Technical documentation for the LACChain EOSIO testnet latamlink.io

This website is created using https://docusaurus.io/, a tool for maintaining technical documentation of open source projects.

Contributions

We use a Kanban style board to prioritize work. Go to the project board.

The main communication channels are github issues and the Telegram channel. Feel free to send any questions you may have.

Contributing Guidelines: https://developers.eoscostarica.io/docs/open-source-guidelines.

Report any bugs big or small by opening an issue.

Edit Content

Documentation is generated from markdown format files located within the /docs sub-folder. See more information here.

Quick guide

File structure

latamlink.io
├── .github
│ ├── workflows
│ | ├── nodejs.yml
│ └─└── services
├── docs
├── src
│ ├── css
│ | ├── custom.css
│ | └── homepage.css
│ └── pages
│ 	├── styles.module.css
│   └── index.js
├── static
│ ├── img
│ ├── imgages
│ ├── scripts
│ ├── js
│ ├── other
│ ├── favicon.ico
│ └── CNAME
├── .gitignore
├── babel.config
├── docusaurus.config.js
├── sidebars.js
├── package.json
├── yarn.lock
└── README.md

Resumen de la estructura del proyecto

  • /docs/ - Contains the Markdown files for the documents. Customize the order of the document sidebar in sidebars.js. More details can be found in the document guide.
  • /src/ - Non-documentation files such as custom React components or pages. You don't have to strictly put your non-documentation files here, but putting them in a centralized directory makes specifying easy in case you need to do some processing.
  • /src/pages - Any file within this directory will become a website page. More details can be found in the page guide .
  • /static/ - Static directory. Any content within here will be copied to the root of the final build directory build.
  • /docusaurus.config.js -The configuration file for the site. This is the equivalent of siteConfig.js in Docusaurus 1.
  • /package.json - A Docusaurus website is a React application. You can install and use any npm package you want on them.
  • /sidebar.js - Used by documentation to specify the order of documents in lateral navigation.

Before to start

Somethings you need before getting started:

  • git
  • node.js

Instructions to run the project locally on Windows 10

  1. Clone this repo
$ git clone https://github.com/LatamLink/latamlink.io.git
  1. Move to the appropriate directory
$ cd latamlink.io
  1. Install all dependencies:
$ yarn install
  1. Build the project:
$ yarn build
  1. Run local server:
$ yarn serve

Publishing

latamlink.io is hosted on GitHub and published using the following commands:

$ yarn build 
$ GIT_USER=LatamLink CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

License

MIT © LatamLink Testnet