-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from bitbomdev/naveen/newTheme2
Redid docs
- Loading branch information
Showing
112 changed files
with
13,769 additions
and
5,031 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,5 +18,3 @@ | |
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
.idea |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
node_modules | ||
/build | ||
.docusaurus | ||
.cache-loader | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
export default { | ||
arrowParens: 'avoid', | ||
bracketSameLine: true, | ||
bracketSpacing: false, | ||
singleQuote: true, | ||
trailingComma: 'all', | ||
tabWidth: 2, | ||
useTabs: false, | ||
semi: true, | ||
printWidth: 80, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
import * as blogPluginExports from '@docusaurus/plugin-content-blog'; | ||
|
||
const defaultBlogPlugin = blogPluginExports.default; | ||
|
||
async function blogPluginExtended(...pluginArgs) { | ||
const blogPluginInstance = await defaultBlogPlugin(...pluginArgs); | ||
|
||
const pluginOptions = pluginArgs[1]; | ||
|
||
return { | ||
...blogPluginInstance, | ||
contentLoaded: async function (params) { | ||
const {content, actions} = params; | ||
|
||
const recentPostsLimit = 3; | ||
const recentPosts = [...content.blogPosts].splice(0, recentPostsLimit); | ||
|
||
async function createRecentPostModule(blogPost, index) { | ||
return { | ||
metadata: await actions.createData( | ||
`home-page-recent-post-metadata-${index}.json`, | ||
JSON.stringify({ | ||
title: blogPost.metadata.title, | ||
description: blogPost.metadata.description, | ||
frontMatter: blogPost.metadata.frontMatter, | ||
}), | ||
), | ||
|
||
Preview: { | ||
__import: true, | ||
path: blogPost.metadata.source, | ||
query: { | ||
truncated: true, | ||
}, | ||
}, | ||
}; | ||
} | ||
|
||
actions.addRoute({ | ||
path: '/', | ||
exact: true, | ||
|
||
component: '@site/src/components/Home/index.tsx', | ||
|
||
modules: { | ||
homePageBlogMetadata: await actions.createData( | ||
'home-page-blog-metadata.json', | ||
JSON.stringify({ | ||
blogTitle: pluginOptions.blogTitle, | ||
blogDescription: pluginOptions.blogDescription, | ||
totalPosts: content.blogPosts.length, | ||
totalRecentPosts: recentPosts.length, | ||
}), | ||
), | ||
recentPosts: await Promise.all( | ||
recentPosts.map(createRecentPostModule), | ||
), | ||
}, | ||
}); | ||
|
||
return blogPluginInstance.contentLoaded(params); | ||
}, | ||
}; | ||
} | ||
|
||
module.exports = { | ||
...blogPluginExports, | ||
default: blogPluginExtended, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: Starting up Minefield | ||
slug: starting-up-minefield | ||
description: 'Learn how to start up Minefield' | ||
authors: [ bitbomdev ] | ||
tags: [ starting-up-minefield ] | ||
--- | ||
|
||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
import Install from '../src/partials/_installMinefield.mdx'; | ||
import InstallScorecardCollector from '../src/partials/_installScorecardCollector.mdx'; | ||
|
||
# Starting up Minefield | ||
|
||
Learn how to install [Minefield](https://github.com/bitbomdev/minefield) | ||
|
||
## Installation | ||
|
||
The installation consists of two main components: | ||
- **Minefield**: The core engine that graphs and analyzes Software Bill of Materials (SBOM) data | ||
- **Scorecard Downloader**: A tool to fetch OpenSSF Scorecard data for GitHub repositories (optional) | ||
|
||
## Installing Minefield | ||
|
||
<Install/> | ||
|
||
## Installing Scorecard Downloader (Optional) | ||
|
||
The Scorecard Downloader helps fetch security metrics data that can be ingested into Minefield. You can skip this step if you have your own data source. | ||
|
||
<InstallScorecardCollector/> |
Oops, something went wrong.