diff --git a/.gitignore b/.gitignore index b0a661c55..aeee1b4ce 100644 --- a/.gitignore +++ b/.gitignore @@ -35,4 +35,5 @@ docs/flowchart.png docs/subnets/ docs/chainhook/ docs/ordinals-api +docs/ordhook /openapi diff --git a/docusaurus.config.js b/docusaurus.config.js index 274fa0074..107419b90 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -193,6 +193,29 @@ module.exports = { }, }, ], + [ + 'docusaurus-plugin-remote-content', + { + name: 'remote-docs-ordhook-docs', + sourceBaseUrl: 'https://raw.githubusercontent.com/hirosystems/ordhook/develop/docs/', + outDir: 'docs/ordhook', + documents: ['getting-started.md', 'overview.md'], + }, + ], + [ + 'docusaurus-plugin-remote-content', + { + name: 'remote-docs-ordhook-how-to', + sourceBaseUrl: + 'https://raw.githubusercontent.com/hirosystems/ordhook/develop/docs/how-to-guides/', + outDir: 'docs/ordhook/how-to-guides', + documents: [ + 'how-to-run-ordhook-as-a-service-using-bitcoind.md', + 'how-to-scan-ordinal-activities.md', + 'how-to-stream-ordinal-activities.md', + ], + }, + ], [ 'docusaurus-plugin-remote-content', { @@ -426,6 +449,7 @@ module.exports = { 'token-metadata-api': 'https://github.com/hirosystems/token-metadata-api/tree/develop/docs', chainhook: 'https://github.com/hirosystems/chainhook/tree/develop/docs', + ordhook: 'https://github.com/hirosystems/ordhook/tree/develop/docs', }; const [repo, ...rem] = docPath.split('/'); if (repo in repoUrls) { diff --git a/sidebars.js b/sidebars.js index 8eaac8b85..95632fffe 100644 --- a/sidebars.js +++ b/sidebars.js @@ -347,6 +347,39 @@ module.exports = { 'platform/faq', ], }, + { + type: 'category', + label: 'Ordhook', + items: [ + 'ordhook/overview', + 'ordhook/getting-started', + { + type: 'category', + label: 'How-to Guides', + items: [ + 'ordhook/how-to-guides/how-to-run-ordhook-as-a-service-using-bitcoind', + 'ordhook/how-to-guides/how-to-scan-ordinal-activities', + 'ordhook/how-to-guides/how-to-stream-ordinal-activities', + ], + }, + { + type: 'category', + label: 'Developer Resources', + items: [ + { + type: 'link', + label: 'Contribution Guidelines', + href: 'https://github.com/hirosystems/ordhook/tree/develop', + }, + { + type: 'link', + label: 'Discord #General', + href: 'https://discord.com/channels/621759717756370964/621759718192447502', + }, + ], + }, + ], + }, { type: 'category', label: 'Stacks.js',