Skip to content
This repository has been archived by the owner on Feb 3, 2023. It is now read-only.

Commit

Permalink
chore: Create basic docusaurus system using docs-only setup
Browse files Browse the repository at this point in the history
  • Loading branch information
qdot committed Dec 21, 2022
1 parent c9f8ae0 commit ae84846
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 182 deletions.
13 changes: 13 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
description: Front page
slug: /
---

# Buttplug Developer Guide

A design and development guide for the Buttplug Intimate Device Control System.

By [Kyle Machulis (qDot)](https://kyle.machul.is/about), Lead Buttplug Architect

The Developers Guide Repo is [available on
github](https://github.com/buttplugio/buttplug-developer-guide).
56 changes: 20 additions & 36 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'My Site',
tagline: 'Dinosaurs are cool',
url: 'https://your-docusaurus-test-site.com',
title: 'Buttplug Developer Guide',
tagline: '',
url: 'https://buttplug-developer-guide.docs.buttplug.io',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'facebook', // Usually your GitHub org/user name.
projectName: 'docusaurus', // Usually your repo name.
// organizationName: 'Nonpolynomial Labs, LLC', // Usually your GitHub org/user name.
// projectName: 'docusaurus', // Usually your repo name.

// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
Expand All @@ -34,18 +34,9 @@ const config = {
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
routeBasePath: '/',
},
blog: false,
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
Expand All @@ -57,21 +48,14 @@ const config = {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: 'My Site',
title: 'Buttplug Developer Guide',
logo: {
alt: 'My Site Logo',
src: 'img/logo.svg',
alt: 'Buttplug.io Logo',
src: 'img/logo.png',
},
items: [
{
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Tutorial',
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/buttplugio/buttplug-developer-guide',
label: 'GitHub',
position: 'right',
},
Expand All @@ -85,42 +69,42 @@ const config = {
items: [
{
label: 'Tutorial',
to: '/docs/intro',
to: '/',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
label: 'Discourse Forum',
href: 'https://discuss.buttplug.io',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
href: 'https://discord.buttplug.io',
},
{
label: 'Twitter',
href: 'https://twitter.com/docusaurus',
href: 'https://twitter.com/buttplugio',
},
],
},
{
title: 'More',
items: [
{
label: 'Blog',
to: '/blog',
label: 'Nonpolynomial Blog',
to: 'https://nonpolynomial.com/blog',
},
{
label: 'GitHub',
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/buttplugio',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} Nonpolynomial. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
Expand Down
64 changes: 0 additions & 64 deletions src/components/HomepageFeatures/index.js

This file was deleted.

11 changes: 0 additions & 11 deletions src/components/HomepageFeatures/styles.module.css

This file was deleted.

41 changes: 0 additions & 41 deletions src/pages/index.js

This file was deleted.

23 changes: 0 additions & 23 deletions src/pages/index.module.css

This file was deleted.

7 changes: 0 additions & 7 deletions src/pages/markdown-page.md

This file was deleted.

Binary file added static/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ae84846

Please sign in to comment.