Skip to content

Commit

Permalink
Add IOTA wiki CLI (#381)
Browse files Browse the repository at this point in the history
  • Loading branch information
eike-hass committed Sep 17, 2021
1 parent 542f347 commit 6fea6c5
Show file tree
Hide file tree
Showing 31 changed files with 990 additions and 10,165 deletions.
54 changes: 0 additions & 54 deletions .github/workflows/deploy_docs_to_github_pages.yml

This file was deleted.

16 changes: 2 additions & 14 deletions documentation/.gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,8 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

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

/local-wiki
10 changes: 10 additions & 0 deletions documentation/EXTERNAL_DOCS_CONFIG
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[
"@docusaurus/plugin-content-docs",
{
id: "identity-rs",
path: "external/identity.rs/documentation/docs",
routeBasePath: "identity.rs",
sidebarPath: require.resolve("./external/identity.rs/documentation/sidebars.js"),
remarkPlugins: [require("remark-code-import"), require("remark-import-partial"), require('remark-remove-comments') ],
}
],
7 changes: 7 additions & 0 deletions documentation/EXTERNAL_DOCS_DROPDOWN_CONFIG
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
label: "Identity",
to: "identity.rs/intro",
className: "icon-identity",
activeBaseRegex: 'identity.rs/.*'
},

30 changes: 15 additions & 15 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# Website
# Documentation

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
The documentation is built using [Docusaurus 2](https://docusaurus.io/). The deployment is done through a centralized build from [IOTA WIKI](https://github.com/iota-community/iota-wiki). To run a local instance the [IOTA WIKI CLI](https://github.com/iota-community/iota-wiki-cli) is used.

## Installation
## Prerequisites

```console
yarn install
```
- [Node.js v14.14+](https://nodejs.org/en/)
- [yarn](https://yarnpkg.com/getting-started/install)

## Local Development
## Installation

```console
yarn start
npm i
npm run setup
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
This command checks out a local copy of the wiki and creates links to the content.

## Build
## Local Development

```console
yarn build
npm start
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Deployment
## Tear Down

```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
npm run clean
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
This command deletes the local wiki and local links.


## Including .md file
Expand Down
3 changes: 0 additions & 3 deletions documentation/babel.config.js

This file was deleted.

6 changes: 6 additions & 0 deletions documentation/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"repoName": "identity.rs",
"contentFolder": "documentation",
"localWikiFolder": "local-wiki",
"excludeList": ["node_modules", "target", ".git/", "local-wiki"]
}
131 changes: 0 additions & 131 deletions documentation/docusaurus.config.js

This file was deleted.

0 comments on commit 6fea6c5

Please sign in to comment.