Add basic Redocly config

This commit is contained in:
Roman Hotsiy
2023-10-02 23:13:27 +08:00
committed by mDuo13
parent 6852d58bc3
commit f6be0f0956
5 changed files with 231 additions and 0 deletions

4
content/redirects.yaml Normal file
View File

@@ -0,0 +1,4 @@
'/docs.html':
to: '/docs/'
type: 301 # optional
# more here

98
content/redocly.yaml Normal file
View File

@@ -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

96
content/top-nav.yaml Normal file
View File

@@ -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/

18
package.json Normal file
View File

@@ -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"
}
}

15
tsconfig.json Normal file
View File

@@ -0,0 +1,15 @@
{
"compilerOptions": {
"baseUrl": ".",
"jsx": "react",
"paths": {
"@theme/*": [
"./@theme/*",
"./node_modules/@redocly/theme/src/*"
],
"@portal/*": [
"./node_modules/@redocly/portal/dist/client/App/*"
]
},
}
}