diff --git a/content/redirects.yaml b/content/redirects.yaml new file mode 100644 index 0000000000..505a90fac1 --- /dev/null +++ b/content/redirects.yaml @@ -0,0 +1,4 @@ +'/docs.html': + to: '/docs/' + type: 301 # optional +# more here diff --git a/content/redocly.yaml b/content/redocly.yaml new file mode 100644 index 0000000000..75926cb15b --- /dev/null +++ b/content/redocly.yaml @@ -0,0 +1,98 @@ +ignore: + - content/_*/** +i18n: + defaultLocale: en-US + locales: + - code: en-US + name: English + - code: ja + name: 日本語 +redirects: + $ref: redirects.yaml +theme: + scripts: + head: + - src: ./static/js/xrpl-2.11.0.min.js + - src: ./static/vendor/jquery-3.7.1.min.js + - src: ./static/vendor/bootstrap.min.js + links: + - href: https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700&display=swap + rel: stylesheet + - href: https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400,600,700&display=swap + rel: stylesheet + - href: ./static/css/devportal2022-v25.css + rel: stylesheet + - href: ./static/vendor/fontawesome/css/font-awesome.min.css + rel: stylesheet + + logo: + srcSet: ./static/img/XRPLedger_DevPortal-black.svg light ./static/img/XRPLedger_DevPortal-white.svg dark' + altText: XRP Ledger Developer Portal + link: / + # favicon: + navbar: + # hide: + items: + $ref: top-nav.yaml + # footer: + # # hide: + # copyrightText: © 2022-2023, Redocly Inc. All right reserved. + # items: + # - group: Legal + # items: + # - label: Terms of Use + # href: 'https://redocly.com/subscription-agreement/' + # - label: Privacy Notice + # href: 'https://redocly.com/privacy-policy/' + # - label: Cookie Notice + # href: 'https://redocly.com/privacy-policy/' + # - group: Social + # items: + # - label: Facebook + # href: 'https://www.facebook.com/redocly/' + # - label: Youtube + # href: 'https://www.youtube.com/channel/UCxYbPjnpqmHCmwg9iWf7wtQ' + # - label: Twitter + # href: 'https://twitter.com/Redocly' + # sidebar: + # hide: + # search: + # placement: + # hide: + # colorMode: #... + # navigation: + # nextButton: + # hide: + # label: + # previousButton: + # hide: + # label: + # markdown: + # frontMatterKeysToResolve: + # lastUpdatedBlock: + # format: + # locale: + # hide: + # toc: + # header: + # depth: + # hide: + # editPage: + # baseUrl: + # text: + # hide: + # codeSnippet: + # copy: + # buttonText: + # tooltipText: + # toasterText: + # toasterDuration: + # hide: + # report: + # label: + # tooltipText: + # hide: + # openapi: + # all openapi docs options + # graphql: + # all graphql docs options \ No newline at end of file diff --git a/content/top-nav.yaml b/content/top-nav.yaml new file mode 100644 index 0000000000..f27b9ed0e0 --- /dev/null +++ b/content/top-nav.yaml @@ -0,0 +1,96 @@ +# alertbanner: +# show: true +# message: This is the draft Redocly version of the site! +# button: Cool +# link: https://github.com/ripple/xrpl-org-dev-portal + +# nav: +- group: About + items: + - group: XRP Ledger Overview + items: + - label: XRPL Overview + link: /about/xrp-ledger-overview/ + - label: Use Cases + link: /about/use-cases/ + - label: History + link: /about/history/ + - label: Ledger Explorer + link: https://livenet.xrpl.org + external: true + - group: XRP + items: + - label: XRP Overview + link: /about/xrp-overview + - group: Sustainability + items: + - label: Impact + link: /about/impact/ + - group: About + items: + - label: XRPL Foundation + link: https://foundation.xrpl.org/ + external: true + - label: FAQ + link: /about/faq/ + +- group: Docs + items: + - hero: top-nav-hero-docs + label: Documentation + description: Dive into XRP Ledger technology and start integrating. + link: /docs/ + - group: Introduction to the XRP Ledger + items: + - label: What is XRP? + link: /docs/concepts/introduction/what-is-xrp + - label: What is the XRP Ledger? + link: /docs/concepts/introduction/what-is-xrpl + - label: Transactions and Requests + link: /docs/concepts/introduction/txn-and-requests + - group: Tutorials + items: + - label: Quickstart + link: /docs/tutorials/quickstart + - label: Code Samples + link: /docs/code-samples + - group: API Reference + items: + - label: Client Libraries + link: /docs/references/client-libraries/ + - label: Public API Methods + link: /docs/references/http-websocket-apis/public-api-methods/ + - label: Admin API Methods + link: /docs/references/http-websocket-apis/admin-api-methods/ + - group: Popular Pages + items: + - label: Send XRP + href: /tutorials/send-xrp/ + - label: XRP Faucets + href: /docs/dev-tools/xrp-faucets/ + - label: XRPL Servers + href: /infrastructure/xrpl-servers/ + - label: Dev Tools + link: /docs/dev-tools/ + + +- group: Community + items: + - hero: top-nav-hero-contribute + label: Contribute to the XRPL Community + description: Join the conversation + link: /community/ + - label: Events + link: /community/events/ + - label: Ambassadors + link: /community/ambassadors/ + - label: XRPL Jobs + link: https://jobs.xrpl.org/ + external: true + - label: Blog + link: /blog/ + - label: XRPL Grants + link: https://xrplgrants.org/ + external: true + - label: Report a Scam + link: /community/report-a-scam/ diff --git a/package.json b/package.json new file mode 100644 index 0000000000..4ba8215b0a --- /dev/null +++ b/package.json @@ -0,0 +1,18 @@ +{ + "name": "xrpl-dev-portal", + "private": true, + "version": "1.0.0", + "type": "module", + "description": "The XRP Ledger Dev Portal is the authoritative source for XRP Ledger documentation, including the `rippled` server, client libraries, and other open-source XRP Ledger software.", + "scripts": { + "start": "portal develop -d content" + }, + "keywords": [], + "license": "MIT", + "dependencies": { + "@redocly/portal": "^0.43.1" + }, + "devDependencies": { + "htmltojsx": "^0.3.0" + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000000..b741d31f79 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,15 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "jsx": "react", + "paths": { + "@theme/*": [ + "./@theme/*", + "./node_modules/@redocly/theme/src/*" + ], + "@portal/*": [ + "./node_modules/@redocly/portal/dist/client/App/*" + ] + }, + } +} \ No newline at end of file