Skip to content

Commit

Permalink
Add version info
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Electron committed Jun 7, 2022
1 parent 40e3da1 commit 927e686
Show file tree
Hide file tree
Showing 12 changed files with 12,154 additions and 10,987 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/test-docs-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Test Docs Build

on:
pull_request:
branches:
- master

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
checks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Test Build
run: |
cd documentation
yarn install --immutable
yarn build
13 changes: 10 additions & 3 deletions documentation/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Dependencies
/node_modules
node_modules

# Yarn
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions

# Production
/build
Expand All @@ -18,5 +27,3 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

local-wiki
785 changes: 785 additions & 0 deletions documentation/.yarn/releases/yarn-3.2.0.cjs

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions documentation/.yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nodeLinker: node-modules

yarnPath: .yarn/releases/yarn-3.2.0.cjs
10 changes: 0 additions & 10 deletions documentation/EXTERNAL_DOCS_CONFIG

This file was deleted.

7 changes: 0 additions & 7 deletions documentation/EXTERNAL_DOCS_DROPDOWN_CONFIG

This file was deleted.

20 changes: 5 additions & 15 deletions documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,20 @@ The documentation is built using [Docusaurus 2](https://docusaurus.io/). The dep
## Installation

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

This command checks out a local copy of the wiki and creates links to the content.
This command installs all necessary dependencies.

## Local Development

```console
npm start
yarn start
```

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 starts a local, wiki themed development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Tear Down

```console
npm run clean
```

This command deletes the local wiki and local links.


## Including .md file
## Including .md file

```console
{@import <file path>}
Expand Down
6 changes: 0 additions & 6 deletions documentation/config.json

This file was deleted.

78 changes: 15 additions & 63 deletions documentation/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,71 +1,23 @@
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const path = require('path');

/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
title: 'IOTA Smart Contract Protocol',
tagline: 'IOTA smart contract protocol.',
url: 'https://iscp.docs.iota.org',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
favicon: '/img/logo/favicon.ico',
organizationName: 'iotaledger',
trailingSlash: true,
projectName: 'wasp',
stylesheets: [
'https://fonts.googleapis.com/css?family=Material+Icons',
],
themeConfig: {
navbar: {
title: 'ISCP',
logo: {
alt: 'IOTA',
src: 'img/logo/WASP_logo_dark.png',
},
items: [
{
type: 'doc',
docId: 'overview',
position: 'left',
label: 'Documentation',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Documentation',
items: [
{
label: 'Overview',
to: '/docs/overview',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} IOTA Foundation, Built with Docusaurus.`,
},
prism: {
additionalLanguages: ['rust'],
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
},
presets: [
plugins: [
[
'@docusaurus/preset-classic',
'@docusaurus/plugin-content-docs',
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
editUrl:
'https://github.com/iotaledger/chronicle.rs/tree/main/docs',
},
theme: {
customCss: require.resolve('./src/css/iota.css'),
id: 'wasp',
path: path.resolve(__dirname, 'docs'),
routeBasePath: 'smart-contracts',
sidebarPath: path.resolve(__dirname, 'sidebars.js'),
editUrl: 'https://github.com/iotaledger/wasp/edit/master/documentation',
remarkPlugins: [require('remark-code-import'), require('remark-import-partial'), require('remark-remove-comments')],
versions: {
current: {
label: 'Stable',
},
},
},
}
],
],
staticDirectories: [path.resolve(__dirname, 'static')],
};
Loading

0 comments on commit 927e686

Please sign in to comment.