Skip to content

Commit

Permalink
Enforce coding standard
Browse files Browse the repository at this point in the history
Co-authored-by: Dr-Electron <dr-electr0n@protonmail.com>
  • Loading branch information
jlvandenhout and Dr-Electron committed Sep 28, 2021
1 parent d1285e6 commit 9553f23
Show file tree
Hide file tree
Showing 41 changed files with 1,441 additions and 788 deletions.
27 changes: 27 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"env": {
"browser": true,
"node": true,
"es2021": true
},
"extends": [
"eslint:recommended",
"plugin:react/recommended",
"prettier"
],
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 12,
"sourceType": "module"
},
"plugins": [
"react"
],
"settings": {
"react": {
"version": "detect"
}
}
}
4 changes: 2 additions & 2 deletions .github/workflows/EXTERNAL_DOCS_CONFIG
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@
path: "external/IOTA-2.0-Research-Specifications/docs",
routeBasePath: "IOTA-2.0-Research-Specifications",
sidebarPath: require.resolve("./external/IOTA-2.0-Research-Specifications/sidebars.js"),
remarkPlugins: [math],
rehypePlugins: [katex],
remarkPlugins: [require('remark-math')],
rehypePlugins: [require('rehype-katex')],
}
],
[
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,6 @@

npm-debug.log*
yarn-debug.log*
yarn-error.log*
yarn-error.log*

.eslintcache
1 change: 1 addition & 0 deletions .husky/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged
9 changes: 9 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader
5 changes: 5 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"singleQuote": true,
"jsxSingleQuote": true,
"trailingComma": "all"
}
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]



<!-- PROJECT LOGO -->
<br />
<p align="center">
Expand All @@ -31,8 +29,6 @@
</p>
</p>



<!-- TABLE OF CONTENTS -->
<details open="open">
<summary>Table of Contents</summary>
Expand All @@ -55,9 +51,8 @@
</ol>
</details>



<!-- MENU STRUCTURE - CONTENT CREATION IN PROGRESS -->

## Menu Structure - Content creation in progress - ASK FOR YOUR HELP!

Please feel free to contribute to any of the available pages. This is the current state of progress:
Expand All @@ -68,8 +63,8 @@ https://www.notion.so/iotafoundation/Contribute-to-the-IOTA-Wiki-698e95b0bac8469

Please mark the page you work on "in progress"


<!-- ABOUT THE PROJECT -->

## About The Project

The IOTA wiki is a central hub for entering into the IOTA eco-system. A community driven initiative to provide an up-to-date collection of introductions and further reading for the Tech, The Teams, The Community, and everything in between. So anyone can learn how to build, adopt, and engage with IOTA, all in one space.
Expand All @@ -79,6 +74,7 @@ The IOTA wiki is a central hub for entering into the IOTA eco-system. A communit
The IOTA wiki and content is contained within this repo, and the system has been built using [Docusaurus v2.0](https://docusaurus.io/).

<!-- GETTING STARTED -->

## Getting Started

### Prerequisites
Expand All @@ -88,10 +84,11 @@ Install [Node.js](https://nodejs.org/en/download/).
### Local Development

1. Run `yarn install` in your terminal. If you want to also install the external docs use `yarn cli start` and `yarn cli checkout`
3. Run `npx docusaurus start`
2. Open `http://localhost:3000`
2. Run `npx docusaurus start`
3. Open `http://localhost:3000`

<!-- CONTRIBUTING -->

## Contributing

The IOTA wiki is a community development and we will review all pull-requests and issues posted to this repository. If you notice any errors, or feel we have forgot something, please feel free to create a pull request with any suggestions. Larger content additions and suggestions can start as issues which can further be discussed with the team maintaining the page.
Expand All @@ -104,24 +101,24 @@ Have a look at [CONTRIBUTING](.github/CONTRIBUTING.md).
5. Open a Pull Request

<!-- CONTACT -->

## Contact

Phylo - [Phyloiota](https://github.com/Phyloiota) - Phylo [Community DAO - lets go!]#2233
Jeroen van den Hout - [jlvandenhout](https://github.com/jlvandenhout) - jvdhout#4402
Dr.Electron - [Dr-Electron](https://github.com/Dr-Electron) - Dr.Electron#9370
Adamski - [AdamCroply](https://github.com/AdamCroply) - adamski#0458

Adamski - [AdamCroply](https://github.com/AdamCroply) - adamski#0458

## Donate

The IOTA wiki is a completely voluntary project put together, maintained, and contributed to by a group of enthusiastic community members.
The IOTA wiki is a completely voluntary project put together, maintained, and contributed to by a group of enthusiastic community members.
Feel free to support our work:


#### iota1qzrmyrnfhfauhv6gax50ncx844uppq4c5dddp3gk99ha0lx5jeqkwk6dapx

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/iota-community/iota-wiki.svg?style=for-the-badge
[contributors-url]: https://github.com/iota-community/iota-wiki/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/iota-community/iota-wiki.svg?style=for-the-badge
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ New article: "Exploring IOTA 2.0 Smart Contracts in a Private Network: Developin
To help interested developers and the IOTA community to more quickly try out smart contracts, this article describes how to set up a private IOTA network with the latest state of the software and demonstrates a workable prediction market smart contract developed in Rust.

Read the article on:
[Medium](https://medium.com/51nodes/exploring-iota-2-0-smart-contracts-in-a-private-network-developing-a-prediction-market-c2d81988f75e)
[Medium](https://medium.com/51nodes/exploring-iota-2-0-smart-contracts-in-a-private-network-developing-a-prediction-market-c2d81988f75e)
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ New article: "My opinion on IOTA Smart Contract Protocol (ISCP) — security imp
ISCP is IOTA’s take to bring Smart Contracts to their DLT.

Read the article on:
[Medium](https://luka99.medium.com/my-opinion-on-iota-smart-contract-protocol-iscp-security-improvement-proposal-c6ca3ca3df23)
[Medium](https://luka99.medium.com/my-opinion-on-iota-smart-contract-protocol-iscp-security-improvement-proposal-c6ca3ca3df23)
Loading

0 comments on commit 9553f23

Please sign in to comment.