Skip to content

Latest commit

History

254 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Trustlines Developer docs

This repository holds the sources for the trustlines developer docs website. The docs here aim to be the ultimate source of truth for the whole trustlines project. We are using docusaurus to build the website of the docs, but you don't need to understand how docusaurus works in order to update the docs. Just find the .md file that needs modification/improvements, modify it and submit a PR request. If approved our automatic publishing process will kick-in and will build a new version of this website and deploy it.

Docs structure

Currently, this repository is structured to allow versioning of all docs, although currently this is only done for the clientlib docs.

The docs for every trustline project(blockchain, clientlib etc.) are organized in folders with the respective names of the projects. When we later in this docs mention DOC_PLUGIN_ID we refer to the id specified in the plugins section of docusaurus.config.js for the @docusaurus/plugin-content-docs plugin.

Working with docusaurus

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning Docs

If the content is ready to be frozen as a version run:

yarn run docusaurus docs:version:DOC_PLUGIN_ID <version>

The currently available values for DOC_PLUGIN_ID can be found in the docusaurus.config.js file.

Running this command will generate a DOC_PLUGIN_ID_versioned_docs/version folder and will copy the docs from the DOC_PLUGIN_ID folder to it. If you need to make modifications to the docs of that version you now need to make the modifications in the DOC_PLUGIN_ID_versioned_docs/version folder.

Note on versions

Keep the number of versions small. The more versions we have the longer the build times. The latest version + the last 2 major versions is a good rule of thumb.

Delete an existing version

  1. Remove the version from the DOC_PLUGIN_ID_versions.json file.
  2. Delete the versioned docs directory. Example: DOC_PLUGIN_ID_versioned_docs/version-1.8.0
  3. Delete the versioned sidebar file. Example DOC_PLUGIN_ID_versioned_sidebars/version-1.8.0-sidebars.json

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

Notes on clientlib/api

Never modify the clientlib/api docs directly!

The clientlib/api folder is created automatically by the docusaurus-plugin-typedoc plugin. For that plugin to work the clientlib repo is included as a git submodule. Docs are then generated when you run yarn start or yarn build. If you need to make modifications to the clientlib/api docs - fix the corresponding file in the clientlib repo. Once the change there gets approved you need to pull the latest changes from the clientlib repo in the submodule and rebuild the docs.

To do that, you can simply run yarn which will execute the script scripts/postinstall.sh and it will pull and install the clientlib submodule.

Markdown

For a full list of supported markdown syntax refer to the docusaurus docs

About

Technical documentation around the Trustlines protocol

Resources

Contributing

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - trustlines-protocol/tl-dev-docs: Technical documentation around the Trustlines protocol · GitHub
Skip to content

Latest commit

History

254 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Trustlines Developer docs

This repository holds the sources for the trustlines developer docs website. The docs here aim to be the ultimate source of truth for the whole trustlines project. We are using docusaurus to build the website of the docs, but you don't need to understand how docusaurus works in order to update the docs. Just find the .md file that needs modification/improvements, modify it and submit a PR request. If approved our automatic publishing process will kick-in and will build a new version of this website and deploy it.

Docs structure

Currently, this repository is structured to allow versioning of all docs, although currently this is only done for the clientlib docs.

The docs for every trustline project(blockchain, clientlib etc.) are organized in folders with the respective names of the projects. When we later in this docs mention DOC_PLUGIN_ID we refer to the id specified in the plugins section of docusaurus.config.js for the @docusaurus/plugin-content-docs plugin.

Working with docusaurus

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning Docs

If the content is ready to be frozen as a version run:

yarn run docusaurus docs:version:DOC_PLUGIN_ID <version>

The currently available values for DOC_PLUGIN_ID can be found in the docusaurus.config.js file.

Running this command will generate a DOC_PLUGIN_ID_versioned_docs/version folder and will copy the docs from the DOC_PLUGIN_ID folder to it. If you need to make modifications to the docs of that version you now need to make the modifications in the DOC_PLUGIN_ID_versioned_docs/version folder.

Note on versions

Keep the number of versions small. The more versions we have the longer the build times. The latest version + the last 2 major versions is a good rule of thumb.

Delete an existing version

  1. Remove the version from the DOC_PLUGIN_ID_versions.json file.
  2. Delete the versioned docs directory. Example: DOC_PLUGIN_ID_versioned_docs/version-1.8.0
  3. Delete the versioned sidebar file. Example DOC_PLUGIN_ID_versioned_sidebars/version-1.8.0-sidebars.json

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

Notes on clientlib/api

Never modify the clientlib/api docs directly!

The clientlib/api folder is created automatically by the docusaurus-plugin-typedoc plugin. For that plugin to work the clientlib repo is included as a git submodule. Docs are then generated when you run yarn start or yarn build. If you need to make modifications to the clientlib/api docs - fix the corresponding file in the clientlib repo. Once the change there gets approved you need to pull the latest changes from the clientlib repo in the submodule and rebuild the docs.

To do that, you can simply run yarn which will execute the script scripts/postinstall.sh and it will pull and install the clientlib submodule.

Markdown

For a full list of supported markdown syntax refer to the docusaurus docs

About

Technical documentation around the Trustlines protocol

Resources

Contributing

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - trustlines-protocol/tl-dev-docs: Technical documentation around the Trustlines protocol · GitHub
Skip to content

Latest commit

History

254 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Trustlines Developer docs

This repository holds the sources for the trustlines developer docs website. The docs here aim to be the ultimate source of truth for the whole trustlines project. We are using docusaurus to build the website of the docs, but you don't need to understand how docusaurus works in order to update the docs. Just find the .md file that needs modification/improvements, modify it and submit a PR request. If approved our automatic publishing process will kick-in and will build a new version of this website and deploy it.

Docs structure

Currently, this repository is structured to allow versioning of all docs, although currently this is only done for the clientlib docs.

The docs for every trustline project(blockchain, clientlib etc.) are organized in folders with the respective names of the projects. When we later in this docs mention DOC_PLUGIN_ID we refer to the id specified in the plugins section of docusaurus.config.js for the @docusaurus/plugin-content-docs plugin.

Working with docusaurus

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning Docs

If the content is ready to be frozen as a version run:

yarn run docusaurus docs:version:DOC_PLUGIN_ID <version>

The currently available values for DOC_PLUGIN_ID can be found in the docusaurus.config.js file.

Running this command will generate a DOC_PLUGIN_ID_versioned_docs/version folder and will copy the docs from the DOC_PLUGIN_ID folder to it. If you need to make modifications to the docs of that version you now need to make the modifications in the DOC_PLUGIN_ID_versioned_docs/version folder.

Note on versions

Keep the number of versions small. The more versions we have the longer the build times. The latest version + the last 2 major versions is a good rule of thumb.

Delete an existing version

  1. Remove the version from the DOC_PLUGIN_ID_versions.json file.
  2. Delete the versioned docs directory. Example: DOC_PLUGIN_ID_versioned_docs/version-1.8.0
  3. Delete the versioned sidebar file. Example DOC_PLUGIN_ID_versioned_sidebars/version-1.8.0-sidebars.json

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

Notes on clientlib/api

Never modify the clientlib/api docs directly!

The clientlib/api folder is created automatically by the docusaurus-plugin-typedoc plugin. For that plugin to work the clientlib repo is included as a git submodule. Docs are then generated when you run yarn start or yarn build. If you need to make modifications to the clientlib/api docs - fix the corresponding file in the clientlib repo. Once the change there gets approved you need to pull the latest changes from the clientlib repo in the submodule and rebuild the docs.

To do that, you can simply run yarn which will execute the script scripts/postinstall.sh and it will pull and install the clientlib submodule.

Markdown

For a full list of supported markdown syntax refer to the docusaurus docs

About

Technical documentation around the Trustlines protocol

Resources

Contributing

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - trustlines-protocol/tl-dev-docs: Technical documentation around the Trustlines protocol · GitHub
Skip to content

Latest commit

History

254 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Trustlines Developer docs

This repository holds the sources for the trustlines developer docs website. The docs here aim to be the ultimate source of truth for the whole trustlines project. We are using docusaurus to build the website of the docs, but you don't need to understand how docusaurus works in order to update the docs. Just find the .md file that needs modification/improvements, modify it and submit a PR request. If approved our automatic publishing process will kick-in and will build a new version of this website and deploy it.

Docs structure

Currently, this repository is structured to allow versioning of all docs, although currently this is only done for the clientlib docs.

The docs for every trustline project(blockchain, clientlib etc.) are organized in folders with the respective names of the projects. When we later in this docs mention DOC_PLUGIN_ID we refer to the id specified in the plugins section of docusaurus.config.js for the @docusaurus/plugin-content-docs plugin.

Working with docusaurus

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning Docs

If the content is ready to be frozen as a version run:

yarn run docusaurus docs:version:DOC_PLUGIN_ID <version>

The currently available values for DOC_PLUGIN_ID can be found in the docusaurus.config.js file.

Running this command will generate a DOC_PLUGIN_ID_versioned_docs/version folder and will copy the docs from the DOC_PLUGIN_ID folder to it. If you need to make modifications to the docs of that version you now need to make the modifications in the DOC_PLUGIN_ID_versioned_docs/version folder.

Note on versions

Keep the number of versions small. The more versions we have the longer the build times. The latest version + the last 2 major versions is a good rule of thumb.

Delete an existing version

  1. Remove the version from the DOC_PLUGIN_ID_versions.json file.
  2. Delete the versioned docs directory. Example: DOC_PLUGIN_ID_versioned_docs/version-1.8.0
  3. Delete the versioned sidebar file. Example DOC_PLUGIN_ID_versioned_sidebars/version-1.8.0-sidebars.json

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

Notes on clientlib/api

Never modify the clientlib/api docs directly!

The clientlib/api folder is created automatically by the docusaurus-plugin-typedoc plugin. For that plugin to work the clientlib repo is included as a git submodule. Docs are then generated when you run yarn start or yarn build. If you need to make modifications to the clientlib/api docs - fix the corresponding file in the clientlib repo. Once the change there gets approved you need to pull the latest changes from the clientlib repo in the submodule and rebuild the docs.

To do that, you can simply run yarn which will execute the script scripts/postinstall.sh and it will pull and install the clientlib submodule.

Markdown

For a full list of supported markdown syntax refer to the docusaurus docs

About

Technical documentation around the Trustlines protocol

Resources

Contributing

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - trustlines-protocol/tl-dev-docs: Technical documentation around the Trustlines protocol · GitHub
Skip to content

Latest commit

History

254 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Trustlines Developer docs

This repository holds the sources for the trustlines developer docs website. The docs here aim to be the ultimate source of truth for the whole trustlines project. We are using docusaurus to build the website of the docs, but you don't need to understand how docusaurus works in order to update the docs. Just find the .md file that needs modification/improvements, modify it and submit a PR request. If approved our automatic publishing process will kick-in and will build a new version of this website and deploy it.

Docs structure

Currently, this repository is structured to allow versioning of all docs, although currently this is only done for the clientlib docs.

The docs for every trustline project(blockchain, clientlib etc.) are organized in folders with the respective names of the projects. When we later in this docs mention DOC_PLUGIN_ID we refer to the id specified in the plugins section of docusaurus.config.js for the @docusaurus/plugin-content-docs plugin.

Working with docusaurus

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning Docs

If the content is ready to be frozen as a version run:

yarn run docusaurus docs:version:DOC_PLUGIN_ID <version>

The currently available values for DOC_PLUGIN_ID can be found in the docusaurus.config.js file.

Running this command will generate a DOC_PLUGIN_ID_versioned_docs/version folder and will copy the docs from the DOC_PLUGIN_ID folder to it. If you need to make modifications to the docs of that version you now need to make the modifications in the DOC_PLUGIN_ID_versioned_docs/version folder.

Note on versions

Keep the number of versions small. The more versions we have the longer the build times. The latest version + the last 2 major versions is a good rule of thumb.

Delete an existing version

  1. Remove the version from the DOC_PLUGIN_ID_versions.json file.
  2. Delete the versioned docs directory. Example: DOC_PLUGIN_ID_versioned_docs/version-1.8.0
  3. Delete the versioned sidebar file. Example DOC_PLUGIN_ID_versioned_sidebars/version-1.8.0-sidebars.json

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

Notes on clientlib/api

Never modify the clientlib/api docs directly!

The clientlib/api folder is created automatically by the docusaurus-plugin-typedoc plugin. For that plugin to work the clientlib repo is included as a git submodule. Docs are then generated when you run yarn start or yarn build. If you need to make modifications to the clientlib/api docs - fix the corresponding file in the clientlib repo. Once the change there gets approved you need to pull the latest changes from the clientlib repo in the submodule and rebuild the docs.

To do that, you can simply run yarn which will execute the script scripts/postinstall.sh and it will pull and install the clientlib submodule.

Markdown

For a full list of supported markdown syntax refer to the docusaurus docs

About

Technical documentation around the Trustlines protocol

Resources

Contributing

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - trustlines-protocol/tl-dev-docs: Technical documentation around the Trustlines protocol · GitHub
Skip to content

Latest commit

History

254 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Trustlines Developer docs

This repository holds the sources for the trustlines developer docs website. The docs here aim to be the ultimate source of truth for the whole trustlines project. We are using docusaurus to build the website of the docs, but you don't need to understand how docusaurus works in order to update the docs. Just find the .md file that needs modification/improvements, modify it and submit a PR request. If approved our automatic publishing process will kick-in and will build a new version of this website and deploy it.

Docs structure

Currently, this repository is structured to allow versioning of all docs, although currently this is only done for the clientlib docs.

The docs for every trustline project(blockchain, clientlib etc.) are organized in folders with the respective names of the projects. When we later in this docs mention DOC_PLUGIN_ID we refer to the id specified in the plugins section of docusaurus.config.js for the @docusaurus/plugin-content-docs plugin.

Working with docusaurus

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning Docs

If the content is ready to be frozen as a version run:

yarn run docusaurus docs:version:DOC_PLUGIN_ID <version>

The currently available values for DOC_PLUGIN_ID can be found in the docusaurus.config.js file.

Running this command will generate a DOC_PLUGIN_ID_versioned_docs/version folder and will copy the docs from the DOC_PLUGIN_ID folder to it. If you need to make modifications to the docs of that version you now need to make the modifications in the DOC_PLUGIN_ID_versioned_docs/version folder.

Note on versions

Keep the number of versions small. The more versions we have the longer the build times. The latest version + the last 2 major versions is a good rule of thumb.

Delete an existing version

  1. Remove the version from the DOC_PLUGIN_ID_versions.json file.
  2. Delete the versioned docs directory. Example: DOC_PLUGIN_ID_versioned_docs/version-1.8.0
  3. Delete the versioned sidebar file. Example DOC_PLUGIN_ID_versioned_sidebars/version-1.8.0-sidebars.json

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

Notes on clientlib/api

Never modify the clientlib/api docs directly!

The clientlib/api folder is created automatically by the docusaurus-plugin-typedoc plugin. For that plugin to work the clientlib repo is included as a git submodule. Docs are then generated when you run yarn start or yarn build. If you need to make modifications to the clientlib/api docs - fix the corresponding file in the clientlib repo. Once the change there gets approved you need to pull the latest changes from the clientlib repo in the submodule and rebuild the docs.

To do that, you can simply run yarn which will execute the script scripts/postinstall.sh and it will pull and install the clientlib submodule.

Markdown

For a full list of supported markdown syntax refer to the docusaurus docs

About

Technical documentation around the Trustlines protocol

Resources

Contributing

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - trustlines-protocol/tl-dev-docs: Technical documentation around the Trustlines protocol · GitHub
Skip to content

Latest commit

History

254 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Trustlines Developer docs

This repository holds the sources for the trustlines developer docs website. The docs here aim to be the ultimate source of truth for the whole trustlines project. We are using docusaurus to build the website of the docs, but you don't need to understand how docusaurus works in order to update the docs. Just find the .md file that needs modification/improvements, modify it and submit a PR request. If approved our automatic publishing process will kick-in and will build a new version of this website and deploy it.

Docs structure

Currently, this repository is structured to allow versioning of all docs, although currently this is only done for the clientlib docs.

The docs for every trustline project(blockchain, clientlib etc.) are organized in folders with the respective names of the projects. When we later in this docs mention DOC_PLUGIN_ID we refer to the id specified in the plugins section of docusaurus.config.js for the @docusaurus/plugin-content-docs plugin.

Working with docusaurus

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning Docs

If the content is ready to be frozen as a version run:

yarn run docusaurus docs:version:DOC_PLUGIN_ID <version>

The currently available values for DOC_PLUGIN_ID can be found in the docusaurus.config.js file.

Running this command will generate a DOC_PLUGIN_ID_versioned_docs/version folder and will copy the docs from the DOC_PLUGIN_ID folder to it. If you need to make modifications to the docs of that version you now need to make the modifications in the DOC_PLUGIN_ID_versioned_docs/version folder.

Note on versions

Keep the number of versions small. The more versions we have the longer the build times. The latest version + the last 2 major versions is a good rule of thumb.

Delete an existing version

  1. Remove the version from the DOC_PLUGIN_ID_versions.json file.
  2. Delete the versioned docs directory. Example: DOC_PLUGIN_ID_versioned_docs/version-1.8.0
  3. Delete the versioned sidebar file. Example DOC_PLUGIN_ID_versioned_sidebars/version-1.8.0-sidebars.json

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

Notes on clientlib/api

Never modify the clientlib/api docs directly!

The clientlib/api folder is created automatically by the docusaurus-plugin-typedoc plugin. For that plugin to work the clientlib repo is included as a git submodule. Docs are then generated when you run yarn start or yarn build. If you need to make modifications to the clientlib/api docs - fix the corresponding file in the clientlib repo. Once the change there gets approved you need to pull the latest changes from the clientlib repo in the submodule and rebuild the docs.

To do that, you can simply run yarn which will execute the script scripts/postinstall.sh and it will pull and install the clientlib submodule.

Markdown

For a full list of supported markdown syntax refer to the docusaurus docs

About

Technical documentation around the Trustlines protocol

Resources

Contributing

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - trustlines-protocol/tl-dev-docs: Technical documentation around the Trustlines protocol · GitHub
Skip to content

Latest commit

History

254 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Trustlines Developer docs

This repository holds the sources for the trustlines developer docs website. The docs here aim to be the ultimate source of truth for the whole trustlines project. We are using docusaurus to build the website of the docs, but you don't need to understand how docusaurus works in order to update the docs. Just find the .md file that needs modification/improvements, modify it and submit a PR request. If approved our automatic publishing process will kick-in and will build a new version of this website and deploy it.

Docs structure

Currently, this repository is structured to allow versioning of all docs, although currently this is only done for the clientlib docs.

The docs for every trustline project(blockchain, clientlib etc.) are organized in folders with the respective names of the projects. When we later in this docs mention DOC_PLUGIN_ID we refer to the id specified in the plugins section of docusaurus.config.js for the @docusaurus/plugin-content-docs plugin.

Working with docusaurus

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning Docs

If the content is ready to be frozen as a version run:

yarn run docusaurus docs:version:DOC_PLUGIN_ID <version>

The currently available values for DOC_PLUGIN_ID can be found in the docusaurus.config.js file.

Running this command will generate a DOC_PLUGIN_ID_versioned_docs/version folder and will copy the docs from the DOC_PLUGIN_ID folder to it. If you need to make modifications to the docs of that version you now need to make the modifications in the DOC_PLUGIN_ID_versioned_docs/version folder.

Note on versions

Keep the number of versions small. The more versions we have the longer the build times. The latest version + the last 2 major versions is a good rule of thumb.

Delete an existing version

  1. Remove the version from the DOC_PLUGIN_ID_versions.json file.
  2. Delete the versioned docs directory. Example: DOC_PLUGIN_ID_versioned_docs/version-1.8.0
  3. Delete the versioned sidebar file. Example DOC_PLUGIN_ID_versioned_sidebars/version-1.8.0-sidebars.json

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

Notes on clientlib/api

Never modify the clientlib/api docs directly!

The clientlib/api folder is created automatically by the docusaurus-plugin-typedoc plugin. For that plugin to work the clientlib repo is included as a git submodule. Docs are then generated when you run yarn start or yarn build. If you need to make modifications to the clientlib/api docs - fix the corresponding file in the clientlib repo. Once the change there gets approved you need to pull the latest changes from the clientlib repo in the submodule and rebuild the docs.

To do that, you can simply run yarn which will execute the script scripts/postinstall.sh and it will pull and install the clientlib submodule.

Markdown

For a full list of supported markdown syntax refer to the docusaurus docs

About

Technical documentation around the Trustlines protocol

Resources

Contributing

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages