Skip to content

Commit

Permalink
(docs) add branding
Browse files Browse the repository at this point in the history
  • Loading branch information
jcubic committed Sep 19, 2024
1 parent 66db267 commit cf724c9
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 23 deletions.
35 changes: 13 additions & 22 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

const config: Config = {
title: 'My Site',
tagline: 'Dinosaurs are cool',
title: 'jQuery Terminal',
tagline: 'Web-Based Terminal library',
favicon: 'img/favicon.ico',

// Set the production url of your site here
Expand All @@ -13,11 +13,6 @@ const config: Config = {
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/jquery.terminal-docs/',

// 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.

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',

Expand All @@ -38,7 +33,7 @@ const config: Config = {
// 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/',
'https://github.com/jcubic/jquery.terminal/tree/docusaurus/docs',
},
blog: {
showReadingTime: true,
Expand All @@ -49,7 +44,7 @@ const config: Config = {
// 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/',
'https://github.com/jcubic/jquery.terminal/tree/docusaurus/docs',
// Useful options to enforce blogging best practices
onInlineTags: 'warn',
onInlineAuthors: 'warn',
Expand All @@ -64,11 +59,11 @@ const config: Config = {

themeConfig: {
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
image: 'img/docusaurus-social-card.png',
navbar: {
title: 'My Site',
title: 'jQuery Terminal',
logo: {
alt: 'My Site Logo',
alt: 'jQuery Terminal logo',
src: 'img/logo.svg',
},
items: [
Expand All @@ -80,7 +75,7 @@ const config: Config = {
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/jcubic/jquery.terminal',
label: 'GitHub',
position: 'right',
},
Expand All @@ -103,15 +98,11 @@ const config: Config = {
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
href: 'https://stackoverflow.com/questions/tagged/jquery-terminal',
},
{
label: 'Twitter',
href: 'https://twitter.com/docusaurus',
label: 'Gitter',
href: 'https://gitter.im/jcubic/jquery.terminal',
},
],
},
Expand All @@ -124,12 +115,12 @@ const config: Config = {
},
{
label: 'GitHub',
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/jcubic/jquery.terminal',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
copyright: `Copyright (c) 2011-${new Date().getFullYear()} <a href="https://jakub.jankiewicz.org">Jakub T. Jankiewicz</a><br/>Website content licenses with <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a> unless noted otherwise.`
},
prism: {
theme: prismThemes.github,
Expand Down
Binary file removed docs/static/img/docusaurus-social-card.jpg
Binary file not shown.
Binary file added docs/static/img/docusaurus-social-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/favicon.ico
Binary file not shown.
49 changes: 48 additions & 1 deletion docs/static/img/logo.svg
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 cf724c9

Please sign in to comment.