Skip to content

Commit 53ad2bb

Browse files
petecheslockjjasgharjessicachitas
authored
Add Remote Content Integration for Docusaurus (#54)
* Create a proof-of-concept for remote-content retreval Remove community/contribute.md - this is pulled via remote-content plugin Add remote-content plugin and pull from sources files in project rewrite any links that are broken Create a utils to easily manage the links to the source Signed-off-by: Pete Cheslock <[email protected]> * JJ added Security.md Looks like I got it working! Signed-off-by: JJ Asghar <[email protected]> * add search bar to nav (#55) Signed-off-by: Jess Chitas <[email protected]> * Create a proof-of-concept for remote-content retreval Remove community/contribute.md - this is pulled via remote-content plugin Add remote-content plugin and pull from sources files in project rewrite any links that are broken Create a utils to easily manage the links to the source Signed-off-by: Pete Cheslock <[email protected]> * Update package-lock.json Signed-off-by: Pete Cheslock <[email protected]> * Update packages from upstream Signed-off-by: Pete Cheslock <[email protected]> * Update .gitignore and docusaurus.config.js; remove security.md - Added security.md to .gitignore to prevent tracking of the file. - Updated docusaurus.config.js to improve plugin organization and clarity. - Removed the security.md file as it is no longer needed. Signed-off-by: Pete Cheslock <[email protected]> * Move contact us lower in the sidebar list Signed-off-by: Pete Cheslock <[email protected]> --------- Signed-off-by: Pete Cheslock <[email protected]> Signed-off-by: JJ Asghar <[email protected]> Signed-off-by: Jess Chitas <[email protected]> Co-authored-by: JJ Asghar <[email protected]> Co-authored-by: Jess Chitas <[email protected]>
1 parent 9e46985 commit 53ad2bb

File tree

13 files changed

+725
-90
lines changed

13 files changed

+725
-90
lines changed

.gitignore

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
node_modules
22
.DS_Store
33
build
4-
.docusaurus
4+
.docusaurus
5+
6+
# Remote content files (downloaded automatically)
7+
docs/community/contribute.md
8+
docs/community/code-of-conduct.md
9+
docs/community/security.md

docs/community/contact_us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 4
33
---
44

55
# Talk to us!

docs/community/contribute.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

docusaurus.config.js

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
// See: https://docusaurus.io/docs/api/docusaurus-config
66

77
import { themes as prismThemes } from "prism-react-renderer";
8+
import remoteContentPlugins from "./remote-content/remote-content.js";
89

910
//import GHiconUrl from "./docs/assets/github-mark-white.svg";
1011
//import LIiconURL from "./docs/assets/linkedin-mark-white.svg";
@@ -94,18 +95,28 @@ const config = {
9495
}),
9596
],
9697
],
97-
markdown: { mermaid: true },
98-
themes: ["@docusaurus/theme-mermaid"],
99-
98+
99+
// Plugins configuration
100100
plugins: [
101+
// Remote content plugins (managed independently)
102+
...remoteContentPlugins,
103+
104+
// Other site plugins
101105
[
102106
require.resolve("docusaurus-lunr-search"),
103107
{
104108
languages: ["en"],
105109
},
106110
],
107-
],
108111

112+
// Examples:
113+
// ['@docusaurus/plugin-google-analytics', { trackingID: 'UA-XXXXXX-X' }],
114+
// ['docusaurus-plugin-sass', {}],
115+
// Add any other plugins you need
116+
],
117+
118+
markdown: { mermaid: true },
119+
themes: ["@docusaurus/theme-mermaid"],
109120

110121
themeConfig:
111122
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */

0 commit comments

Comments
 (0)