Skip to content

Commit

Permalink
Merge pull request #514 from hirosystems/ordhook-docs
Browse files Browse the repository at this point in the history
add ordhook docs
  • Loading branch information
ryanwaits committed Oct 4, 2023
2 parents 80c9e72 + 8ad4bfe commit badccc9
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,5 @@ docs/flowchart.png
docs/subnets/
docs/chainhook/
docs/ordinals-api
docs/ordhook
/openapi
24 changes: 24 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
{
Expand Down Expand Up @@ -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) {
Expand Down
33 changes: 33 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

1 comment on commit badccc9

@vercel
Copy link

@vercel vercel bot commented on badccc9 Oct 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.