Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/docs/about/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 10
---

# About FAIR project

This page is about the project and inside docs, so it has sidebar.
7 changes: 7 additions & 0 deletions docs/docs/contributing/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 100
---

# Contributing to FAIR project

This is the page about contributing to the project.
2 changes: 1 addition & 1 deletion docs/docs/intro.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 50
---

# Tutorial Intro
Expand Down
58 changes: 38 additions & 20 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import {themes as prismThemes} from 'prism-react-renderer';
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'FAIR Documentation',
tagline: 'Docs are way too cool!!',
favicon: 'img/favicon.ico',
tagline: 'Welcome to the FAIR Package Manager Project documentation.',
// favicon: 'img/favicon.ico',

// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
future: {
Expand Down Expand Up @@ -75,24 +75,38 @@ const config = {
respectPrefersColorScheme: true,
},
navbar: {
title: 'My Site',
logo: {
alt: 'My Site Logo',
src: 'img/logo.svg',
},
title: 'FAIR Documentation',
// logo: {
// alt: 'My Site Logo',
// src: 'img/logo.svg',
// },
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: 'Tutorial',
label: 'Docs',
},
{
to: '/blog',
label: 'Blog',
position: 'left'
},
{
to: 'docs/contributing',
label: 'Get involved',
position: 'left'
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/fairpm/docs',
label: 'GitHub',
position: 'right',
},
{
href: 'https://fair.pm/',
label: 'fair.pm',
position: 'right',
},
],
},
footer: {
Expand All @@ -102,25 +116,29 @@ const config = {
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/',
label: 'About this documentation',
to: 'about',
},
{
label: 'Docs GitHub repo',
href: 'https://github.com/fairpm/docs',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
label: 'Slack instance',
href: 'https://chat.fair.pm/',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
label: 'Join meetings',
href: 'https://zoom-lfx.platform.linuxfoundation.org/meetings/fair-package-manager?view=month',
},
{
label: 'X',
href: 'https://x.com/docusaurus',
label: 'GitHub organisation',
href: 'https://github.com/fairpm',
},
],
},
Expand All @@ -132,13 +150,13 @@ const config = {
to: '/blog',
},
{
label: 'GitHub',
href: 'https://github.com/fairpm/docs',
label: 'fair.pm',
href: 'https://fair.pm/',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} FAIR. Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,
Expand Down
28 changes: 14 additions & 14 deletions docs/src/components/HomepageFeatures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@ import styles from './styles.module.css';

const FeatureList = [
{
title: 'Easy to Use',
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
title: 'FAIR',
Svg: require('@site/static/img/globe.svg').default,
description: (
<>
Docusaurus was designed from the ground up to be easily installed and
used to get your website up and running quickly.
<p>FAIR is an acronym for Federated And Independent Repositories.</p>
<p>The FAIR Package Manager is an open-source initiative of The FAIR Web Foundation, a Linux Foundation project.</p>
</>
),
},
{
title: 'Focus on What Matters',
Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
title: 'Technology',
Svg: require('@site/static/img/networking.svg').default,
description: (
<>
Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
ahead and move your docs into the <code>docs</code> directory.
<p>Decentralized alternative for distributing your project dependencies.</p>
<p>Everything is package if you're FAIR enough.</p>
</>
),
},
{
title: 'Powered by React',
Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
title: 'Security, Privacy & GDPR',
Svg: require('@site/static/img/superhero.svg').default,
description: (
<>
Extend or customize your website layout by reusing React. Docusaurus can
be extended while reusing the same header and footer.
<p>FAIR is designed to improve user privacy by reducing unnecessary tracking and central data collection.</p>
<p>Using signing and authentication, FAIR mitigates unapproved takeovers or nulling of your website dependencies, restoring trust in deliverables.</p>
</>
),
},
Expand All @@ -41,9 +41,9 @@ function Feature({Svg, title, description}) {
<div className="text--center">
<Svg className={styles.featureSvg} role="img" />
</div>
<div className="text--center padding-horiz--md">
<div className="text--center padding-horiz--lg">
<Heading as="h3">{title}</Heading>
<p>{description}</p>
<div>{description}</div>
</div>
</div>
);
Expand Down
8 changes: 5 additions & 3 deletions docs/src/components/HomepageFeatures/styles.module.css
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
.features {
display: flex;
align-items: center;
padding: 2rem 0;
padding: 4rem 0;
width: 100%;
}

.featureSvg {
height: 200px;
width: 200px;
height: 120px;
width: 120px;
margin-bottom: 2rem;
position: relative;
}
28 changes: 14 additions & 14 deletions docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #2e8555;
--ifm-color-primary-dark: #29784c;
--ifm-color-primary-darker: #277148;
--ifm-color-primary-darkest: #205d3b;
--ifm-color-primary-light: #33925d;
--ifm-color-primary-lighter: #359962;
--ifm-color-primary-lightest: #3cad6e;
--ifm-color-primary: #234570;
--ifm-color-primary-dark: #203e65;
--ifm-color-primary-darker: #1e3b5f;
--ifm-color-primary-darkest: #18304e;
--ifm-color-primary-light: #274c7b;
--ifm-color-primary-lighter: #284f81;
--ifm-color-primary-lightest: #2e5a92;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: #21af90;
--ifm-color-primary-darker: #1fa588;
--ifm-color-primary-darkest: #1a8870;
--ifm-color-primary-light: #29d5b0;
--ifm-color-primary-lighter: #32d8b4;
--ifm-color-primary-lightest: #4fddbf;
--ifm-color-primary: #94c2ff;
--ifm-color-primary-dark: #6cabff;
--ifm-color-primary-darker: #58a0ff;
--ifm-color-primary-darkest: #1b7dff;
--ifm-color-primary-light: #498feb;
--ifm-color-primary-lighter: #5697ec;
--ifm-color-primary-lightest: #7caef0;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}
7 changes: 7 additions & 0 deletions docs/src/pages/about/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: About FAIR documentation
---

# About this documentation

This page is about the documentation itself and standalone.
8 changes: 4 additions & 4 deletions docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ function HomepageHeader() {
{siteConfig.title}
</Heading>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
{/* <div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Docusaurus Tutorial - 5min ⏱️
</Link>
</div>
</div> */}
</div>
</header>
);
Expand All @@ -32,8 +32,8 @@ export default function Home() {
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
title={`Welcome to ${siteConfig.title}`}
description="Documentation for FAIR project.">
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down
1 change: 1 addition & 0 deletions docs/static/img/globe.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/static/img/key.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/static/img/networking.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/static/img/rest-api.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/static/img/shield.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/static/img/superhero.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading