Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add IOTA wiki CLI #381

Merged
merged 30 commits into from
Sep 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
8add2b1
added wiki build script
eike-hass Sep 2, 2021
d158860
removed build, added local config
eike-hass Sep 2, 2021
7340ef6
removed docs src folder
eike-hass Sep 3, 2021
9d00afe
added wiki-cli
eike-hass Sep 3, 2021
ba40a91
Merge branch 'dev' into feat/fix-docs
eike-hass Sep 3, 2021
18278fe
extend cli commands
eike-hass Sep 6, 2021
733b4f1
remove bash script
eike-hass Sep 6, 2021
4a3dae8
added cli dependencies
eike-hass Sep 6, 2021
b45a44c
use realpath
eike-hass Sep 6, 2021
397098c
use realpath
eike-hass Sep 7, 2021
7fcf5d1
reduce dropdown config
eike-hass Sep 7, 2021
148c742
readded CodeSnippet Component
eike-hass Sep 8, 2021
de96119
rework src and static handling
eike-hass Sep 8, 2021
0c2c017
use juntion for windows
eike-hass Sep 8, 2021
272df2d
use hardlinks instead of symlinks
eike-hass Sep 9, 2021
84c3043
use absolute path
eike-hass Sep 9, 2021
2d2337a
debounce yarn start
eike-hass Sep 9, 2021
d095609
add documentation package
eike-hass Sep 9, 2021
5537b8f
fix type issues, clean up package json
eike-hass Sep 9, 2021
c89504d
Merge branch 'dev' into feat/fix-docs
eike-hass Sep 9, 2021
495c85b
Merge branch 'dev' into feat/fix-docs
eike-hass Sep 13, 2021
5c56c9b
renamed cli to iota-wiki-cli, updated README
eike-hass Sep 13, 2021
defdbef
use local config.json, renamed nuke to clean
eike-hass Sep 13, 2021
a68beac
use iota-wiki-cli from github
eike-hass Sep 13, 2021
6627ade
updated README
eike-hass Sep 13, 2021
74e8cdd
remove github pages workflow
eike-hass Sep 14, 2021
35f32b1
use tagged iota-wiki-cli version
eike-hass Sep 16, 2021
df4e8bc
added prerequisites
eike-hass Sep 17, 2021
36407a6
Merge branch 'dev' into feat/fix-docs
eike-hass Sep 17, 2021
5932d7b
update to iota-wiki-cli@1.0.1
eike-hass Sep 17, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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.