Skip to content

Commit

Permalink
chore: add prettier-config
Browse files Browse the repository at this point in the history
  • Loading branch information
@mdonnalley
mdonnalley committed Mar 29, 2024
1 parent b561a88 commit 3ddcffd
Show file tree
Hide file tree
Showing 4 changed files with 159 additions and 210 deletions.
112 changes: 55 additions & 57 deletions website/docusaurus.config.ts
View file
Original file line number Diff line number Diff line change
@@ -1,61 +1,59 @@
import type { Config } from "@docusaurus/types";
import type {Config} from '@docusaurus/types'

export default async function createConfigAsync() {
return {
title: "oclif: The Open CLI Framework",
tagline: "Create command line tools your users love",
url: "https://oclif.github.io",
baseUrl: "/",
organizationName: "oclif",
projectName: "oclif.github.io",
deploymentBranch: "main",
scripts: ["https://buttons.github.io/buttons.js"],
stylesheets: [
"https://fonts.googleapis.com/css?family=Roboto:400,700|Roboto+Mono",
],
favicon: "img/oclif_rev.svg",
title: 'oclif: The Open CLI Framework',
tagline: 'Create command line tools your users love',
url: 'https://oclif.github.io',
baseUrl: '/',
organizationName: 'oclif',
projectName: 'oclif.github.io',
deploymentBranch: 'main',
scripts: ['https://buttons.github.io/buttons.js'],
stylesheets: ['https://fonts.googleapis.com/css?family=Roboto:400,700|Roboto+Mono'],
favicon: 'img/oclif_rev.svg',
customFields: {
disableHeaderTitle: true,
fonts: {
myFont: ["Roboto", "sans-serif"],
myOtherFont: ["-apple-system", "system-ui"],
myFont: ['Roboto', 'sans-serif'],
myOtherFont: ['-apple-system', 'system-ui'],
},
repoUrl: "https://github.com/oclif/oclif",
repoUrl: 'https://github.com/oclif/oclif',
presets: [
[
"@docusaurus/preset-classic",
'@docusaurus/preset-classic',
{
blog: {
feedOptions: {
type: "all",
title: "oclif.io Blog",
description: "The oclif.io Blog Feed",
copyright: "Copyright © 2023 Salesforce",
type: 'all',
title: 'oclif.io Blog',
description: 'The oclif.io Blog Feed',
copyright: 'Copyright © 2023 Salesforce',
},
},
},
],
],
blogSidebarCount: "ALL",
blogSidebarCount: 'ALL',
},
onBrokenLinks: "log",
onBrokenMarkdownLinks: "log",
onBrokenLinks: 'log',
onBrokenMarkdownLinks: 'log',
presets: [
[
"@docusaurus/preset-classic",
'@docusaurus/preset-classic',
{
docs: {
showLastUpdateAuthor: true,
showLastUpdateTime: true,
editUrl: "https://github.com/oclif/oclif.github.io/tree/docs/docs/",
path: "../docs",
sidebarPath: "../website/sidebars.ts",
editUrl: 'https://github.com/oclif/oclif.github.io/tree/docs/docs/',
path: '../docs',
sidebarPath: '../website/sidebars.ts',
},
blog: {
path: "blog",
path: 'blog',
},
theme: {
customCss: "../website/src/css/custom.css",
customCss: '../website/src/css/custom.css',
},
},
],
Expand All @@ -64,57 +62,57 @@ export default async function createConfigAsync() {
themeConfig: {
navbar: {
logo: {
src: "img/oclif.svg",
srcDark: "img/oclif_rev.svg",
alt: "oclif",
href: "/",
target: "_self",
src: 'img/oclif.svg',
srcDark: 'img/oclif_rev.svg',
alt: 'oclif',
href: '/',
target: '_self',
},
items: [
{
to: "docs/introduction",
label: "Getting Started",
position: "right",
to: 'docs/introduction',
label: 'Getting Started',
position: 'right',
},
{
to: "docs/api_reference",
label: "API Reference",
position: "right",
to: 'docs/api_reference',
label: 'API Reference',
position: 'right',
},
{
to: "blog",
label: "Blog",
position: "right",
to: 'blog',
label: 'Blog',
position: 'right',
},
{
href: "https://github.com/oclif/oclif",
className: "header-github-link",
"aria-label": "GitHub repository",
position: "right",
href: 'https://github.com/oclif/oclif',
className: 'header-github-link',
'aria-label': 'GitHub repository',
position: 'right',
},
],
},
announcementBar: {
id: "announcementBar-1", // Increment on change (otherwise new announcements won't show up for users who have already dismissed old ones)
id: 'announcementBar-1', // Increment on change (otherwise new announcements won't show up for users who have already dismissed old ones)
content: `<b><a target="_blank" href="https://github.com/oclif/core/releases/tag/3.0.0">@oclif/core v3.0</a> is now out! 🥳️</b>`,
},
footer: {
links: [],
copyright: "Copyright © 2023 Salesforce",
copyright: 'Copyright © 2023 Salesforce',
logo: {
src: "img/salesforce-logo.svg",
alt: "Salesforce",
href: "https://developer.salesforce.com",
src: 'img/salesforce-logo.svg',
alt: 'Salesforce',
href: 'https://developer.salesforce.com',
width: 160,
height: 51,
},
},
algolia: {
apiKey: "6032dd3bbb99cdcfacc285354871966c",
indexName: "oclifio",
appId: "Q04FC8Q6OZ",
apiKey: '6032dd3bbb99cdcfacc285354871966c',
indexName: 'oclifio',
appId: 'Q04FC8Q6OZ',
contextualSearch: true,
},
},
} satisfies Config;
} satisfies Config
}
108 changes: 48 additions & 60 deletions website/sidebars.ts
View file
Original file line number Diff line number Diff line change
@@ -1,87 +1,75 @@
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'
const sidebars: SidebarsConfig = {
docs: [
{
label: "Getting Started",
type: "category",
label: 'Getting Started',
type: 'category',
collapsed: false,
items: [
"introduction",
"features",
"faqs",
"generator_commands",
"templates",
],
items: ['introduction', 'features', 'faqs', 'generator_commands', 'templates'],
},
{
label: "Guides",
type: "category",
label: 'Guides',
type: 'category',
collapsed: true,
link: {
type: "generated-index",
slug: "guides",
type: 'generated-index',
slug: 'guides',
},
items: [
"aliases",
"base_class",
"configuring_your_cli",
"debugging",
"error_handling",
"esm",
"flag_inheritance",
"flexible_taxonomy",
"jit_plugins",
"json",
"nsis-installer_customization",
"releasing",
"running_programmatically",
"single_command_cli",
"testing",
"themes",
"user_experience",
'aliases',
'base_class',
'configuring_your_cli',
'debugging',
'error_handling',
'esm',
'flag_inheritance',
'flexible_taxonomy',
'jit_plugins',
'json',
'nsis-installer_customization',
'releasing',
'running_programmatically',
'single_command_cli',
'testing',
'themes',
'user_experience',
],
},
{
label: "API Reference",
type: "category",
label: 'API Reference',
type: 'category',
collapsed: true,
link: {
type: "generated-index",
slug: "api_reference",
type: 'generated-index',
slug: 'api_reference',
},
items: [
"commands",
"args",
"flags",
"config",
"command_discovery_strategies",
"topics",
"topic_separator",
"hooks",
"plugins",
"help_classes",
"performance",
'commands',
'args',
'flags',
'config',
'command_discovery_strategies',
'topics',
'topic_separator',
'hooks',
'plugins',
'help_classes',
'performance',
],
},
{
label: "Architecture",
type: "category",
label: 'Architecture',
type: 'category',
collapsed: true,
items: ["command_execution", "plugin_loading"],
items: ['command_execution', 'plugin_loading'],
},
{
label: "Also See",
type: "category",
label: 'Also See',
type: 'category',
collapsed: true,
items: [
"examples",
"external_links",
"related_repos",
"how_we_work",
"feedback",
],
items: ['examples', 'external_links', 'related_repos', 'how_we_work', 'feedback'],
},
],
};
}

export default sidebars;
export default sidebars
Loading

0 comments on commit 3ddcffd

Please sign in to comment.