resonatecoop / documentation Goto Github PK
View Code? Open in Web Editor NEWProviding support for Resonate's core technology and surrounding ecosystem
Home Page: https://docs.resonate.coop
License: MIT License
Providing support for Resonate's core technology and surrounding ecosystem
Home Page: https://docs.resonate.coop
License: MIT License
Implement/Import Swagger docs via https://github.com/PaloAltoNetworks/docusaurus-openapi-docs
Is your feature request related to a problem? Please describe.
Running yarn start
downloads untracked MD files that we don't want to commit in this repository.
Describe the solution you'd like
Add these to .gitignore
to help to ensure that these files are not committed to in this repository.
Probably something to do with docusaurus-plugin-remote-content
.
Is your feature request related to a problem? Please describe.
Currently, when a user loads up the website, on both desktop and mobile, it defaults to the light theme.
Describe the solution you'd like
The site should default to the dark theme if the user's device is in dark mode / prefers dark.
Is your feature request related to a problem? Please describe.
Implement search bar functionality in the top right of the UI.
Describe the solution you'd like
The docs describe a few options.
We will probably try Angolia DocSearch first.
For reference: rdilweb/docusaurus-plugin-remote-content#40
Once this is supported, we should be able to use something like this configuration to achieve this:
plugins: [
[
"docusaurus-plugin-remote-content",
{
name: "stream", // used by CLI, must be path safe
sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/stream/development/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs/basics", // the base directory to output to.
documents: ["README.md"], // the file names to download
},
{
name: "website", // used by CLI, must be path safe
sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/website/develop/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs/basics", // the base directory to output to.
documents: ["README.md"], // the file names to download
},
{
name: "id", // used by CLI, must be path safe
sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/id/develop/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs/basics", // the base directory to output to.
documents: ["README.md"], // the file names to download
},
{
name: "user-api", // used by CLI, must be path safe
sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/user-api/master/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs/basics", // the base directory to output to.
documents: ["README.md"], // the file names to download
},
{
name: "user-api-client", // used by CLI, must be path safe
sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/user-api-client/master/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs/basics", // the base directory to output to.
documents: ["README.md"], // the file names to download
},
{
name: "beam", // used by CLI, must be path safe
sourceBaseUrl: "https://raw.githubusercontent.com/simonv3/beam/main/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs/ecosystem", // the base directory to output to.
documents: ["README.md"], // the file names to download
},
{
name: "stream-app", // used by CLI, must be path safe
sourceBaseUrl: "https://raw.githubusercontent.com/peterklingelhofer/stream-app/main/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs/ecosystem", // the base directory to output to.
documents: ["README.md"], // the file names to download
},
],
],
Add Edit This Page button to bottom left of each page, as seen on the Docusaurus docs.
Create object, both for this repository and remote repositories:
repository
defaultBranch
organization
readmeFileName
title? // defaults to repo name capitalized and replacing dashes with spaces if not provided
or at least, create a function for some of the behavior in modifyContent
.
This will reduce duplication/redundant code.
Is your feature request related to a problem? Please describe.
GitHub link in navigation bar is currently text.
Describe the solution you'd like
GitHub link should be the GitHub logo, as seen in the Docusaurus documentation.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.