diff --git a/documentation/dev-portal/ama-layout.css b/documentation/dev-portal/ama-layout.css deleted file mode 100644 index 009e2bd37b..0000000000 --- a/documentation/dev-portal/ama-layout.css +++ /dev/null @@ -1,46 +0,0 @@ - /* Community Resources > Nym DevRel AMAs */ - - .video-slider { - display: flex; - overflow-x: auto; - overflow-y: hidden; - scroll-behavior: smooth; - scroll-snap-type: x mandatory; - } - - .video-container { - flex: 0 0 auto; - margin-right: 10px; - width: 320px; - height: 180px; - border: 2px solid #000; - scroll-snap-align: start; - } - - .video { - position: relative; - width: 100%; - height: 0; - padding-bottom: 56.25%; /* 16:9 aspect ratio */ - } - - .video iframe { - position: absolute; - width: 100%; - height: 100%; - border: none; - } - -.video-title { - position: absolute; - top: 0; - left: 0; - right: 0; - margin: 0; - padding: 5px; - font-size: 14px; - text-align: center; - color: #fff; - background-color: rgba(0, 0, 0, 0.5); - z-index: 1; -} \ No newline at end of file diff --git a/documentation/dev-portal/book.toml b/documentation/dev-portal/book.toml index 1b32775db1..0b4720afbc 100644 --- a/documentation/dev-portal/book.toml +++ b/documentation/dev-portal/book.toml @@ -1,21 +1,21 @@ [book] title = "Nym Developer Portal" -authors = ["Oliver Anyanwu", "Max Hampshire"] +authors = ["Max Hampshire"] language = "en" multilingual = false src = "src" ################# # PREPROCESSORS # -################# +################# -# Note if changing these fields: -# - make sure you aren't running `mdbook serve` +# Note if changing these fields: +# - make sure you aren't running `mdbook serve` # - change value of `turn-off = true` to `false`. This is set to `true` usually to avoid a known constant-reload bug with `mdbook serve` and this preprocessor -# - delete `./theme/` dir -# - change the preprocessor values that you want to edit -# - run `mdbook build`: this will rebuild the `./theme` directory -# - change value of `turn-off` back to `true` +# - delete `./theme/` dir +# - change the preprocessor values that you want to edit +# - run `mdbook build`: this will rebuild the `./theme` directory +# - change value of `turn-off` back to `true` [preprocessor.theme] pagetoc = true # some variables related (defined in theme/css/variables.css) @@ -38,29 +38,25 @@ chapter-line-height = "2em" section-line-height = "1.5em" # # if true, never read and touch the files in theme dir -turn-off = true +turn-off = true [preprocessor.admonish] command = "mdbook-admonish" assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install` -# variables preprocessor: import variables into files +# variables preprocessor: import variables into files # https://gitlab.com/tglman/mdbook-variables/ [preprocessor.variables.variables] # code prerequisites versions minimum_rust_version = "1.66" # minimum_node_version = "" -# nym platform code most recent release -platform_release_version = "v1.1.11" +# nym platform code most recent release +platform_release_version = "v1.1.14" [preprocessor.last-changed] command = "mdbook-last-changed" renderer = ["html"] -# more pre-processor plugins to look into from https://github.com/rust-lang/mdBook/wiki/Third-party-plugins & https://lib.rs/keywords/mdbook-preprocessor -# mdbook-mermaid - use mermaid to make diagrams from text! -# mdbook-i18n - ######### # BUILD # ######### @@ -73,16 +69,16 @@ extra-watch-dirs = [] # directories to watch for triggering builds ########## # OUTPUT # -########## +########## [output.html] default-theme = "coal" preferred-dark-theme = "coal" curly-quotes = true -# mathjax-support = false # useful if we want to pull equations in ? +# mathjax-support = false # useful if we want to pull equations in ? copy-fonts = true no-section-label = false -additional-css = ["theme/pagetoc.css", "././mdbook-admonish.css", "last-changed.css", "ama-layout.css"] +additional-css = ["theme/pagetoc.css", "././mdbook-admonish.css", "last-changed.css"] additional-js = ["theme/pagetoc.js"] git-repository-url = "https://github.com/nymtech/dev-portal" git-repository-icon = "fa-github" @@ -95,7 +91,7 @@ site-url = "/developers/" enable = true # whether or not to enable section folding level = 0 # the depth to start folding -# controlling rust sample code blocks +# controlling rust sample code blocks [output.html.playground] editable = false # allows editing the source code copyable = true # include the copy button for copying code snippets @@ -103,7 +99,7 @@ copy-js = true # includes the JavaScript for the code editor line-numbers = false # displays line numbers for editable code runnable = true # displays a run button for rust code -# options for the built in text search +# options for the built in text search [output.html.search] enable = true # enables the search feature limit-results = 30 # maximum number of search results diff --git a/documentation/docs/.gitignore b/documentation/docs/.gitignore index a411e2d11a..e84b38bdfb 100644 --- a/documentation/docs/.gitignore +++ b/documentation/docs/.gitignore @@ -1,17 +1,11 @@ # mdbook files book -book/* +book/* theme/index.hbs theme/pagetoc.css theme/pagetoc.js -theme/* -theme - -# ----------------------- -# Local Development Tools -# ----------------------- -/node_modules -/npm-debug.log +theme/* +theme # --------------- # Compiled assets @@ -19,15 +13,15 @@ theme .sass-cache _site -# ---------- -# Docusaurus -# ---------- -.docusaurus -build -dist - # ---------- # Developing # ---------- todo.md -.vscode +.vscode + +# OSX +.DS_Store + +theme/ +theme +theme/*