Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Commit

Permalink
Add info about Fishjam Cloud (#124)
Browse files Browse the repository at this point in the history
* Add banner

* Remove old links

* Fix styles

* Update readme

* Add info

* Make Cloud strong
  • Loading branch information
mironiasty authored Nov 13, 2024
1 parent 29d832e commit 1ee4dad
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 42 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
> [!IMPORTANT]
> This repository is archived.
>
> Check out our [new documentation](https://github.com/fishjam-cloud/documentation) for [Fishjam Cloud](https://fishjam.io/).
# Fishjam docs

[![pages-build-deployment](https://github.com/fishjam-dev/fishjam-docs/actions/workflows/build_pages.yml/badge.svg)](https://github.com/fishjam-dev/fishjam-docs/actions/workflows/pages/pages-build-deployment)
Expand Down Expand Up @@ -32,8 +37,9 @@ This command generates static content into the `build` directory and can be serv
We follow [the versioning system provided by docusaurus](https://docusaurus.io/docs/versioning)

To create a new docs version:
* make sure that `sidebars.js` and files inside `docs/` directory are up-to-date and ready to be frozen
* run `npm run docusaurus docs:version 1.0.0`

- make sure that `sidebars.js` and files inside `docs/` directory are up-to-date and ready to be frozen
- run `npm run docusaurus docs:version 1.0.0`

## Copyright and License

Expand Down
46 changes: 18 additions & 28 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ const config = {
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
editUrl:
'https://github.com/fishjam-dev/fishjam-docs',
editUrl: 'https://github.com/fishjam-dev/fishjam-docs',
routeBasePath: '/',
},
blog: false,
Expand Down Expand Up @@ -83,7 +82,7 @@ const config = {
id: 'fishjam-rest-apix-0_5_0',
spec: 'https://raw.githubusercontent.com/fishjam-dev/fishjam/v0.5.0/openapi.yaml',
route: '/examples/using-single-yaml-0_5_0/',
}
},
],
// Theme Options for modifying how redoc renders them
theme: {
Expand All @@ -94,12 +93,18 @@ const config = {
],
],

themes: [
'docusaurus-theme-github-codeblock'
],
themes: ['docusaurus-theme-github-codeblock'],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
{
announcementBar: {
id: 'use_fishjam_cloud',
content:
'<h4>Fishjam goes to the Cloud!</h4>After 1.5 years of work we decided to do a pivot and continue the project as <a href="https://fishjam.io/"><strong>Fishjam Cloud</strong></a> making it also closed source.<br />This documentation is no longer maintained.',
backgroundColor: '#ED716D',
textColor: '#091E42',
isCloseable: false,
},
// Replace with your project's social card
image: 'img/logo/favicon.svg',
navbar: {
Expand All @@ -115,26 +120,11 @@ const config = {
position: 'right',
dropdownActiveClassDisabled: true,
},
{
href: 'https://github.com/fishjam-dev/fishjam',
label: 'GitHub',
position: 'right',
},
{
href: 'https://fishjam-dev.github.io/fishjam-dashboard/',
label: 'Fishjam Dashboard',
position: 'left',
},
{
href: 'https://room.fishjam.stream/',
label: 'Fishjam Room',
position: 'left',
},
{
href: 'https://fishjam.io/',
label: 'Fishjam Cloud',
position: 'left',
}
},
],
},
footer: {
Expand Down Expand Up @@ -180,12 +170,12 @@ const config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Software Mansion S.A.`,
copyright: `Copyright © 2024 Software Mansion S.A.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['elixir']
additionalLanguages: ['elixir'],
},
algolia: {
// The application ID provided by Algolia
Expand All @@ -209,9 +199,9 @@ const config = {
codeblock: {
showGithubLink: true,
githubLinkLabel: 'View on GitHub',
showRunmeLink: false
}
}),
showRunmeLink: false,
},
},
};

module.exports = config;
25 changes: 13 additions & 12 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,26 @@

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #3F57A6;
--ifm-color-primary-darkest: #001A72;
--ifm-color-primary-light: #7089DB;
--ifm-color-primary-lighter: #BFCCF8;
--ifm-color-primary-lightest: #F5F7FE;
--ifm-color-primary: #3f57a6;
--ifm-color-primary-darkest: #001a72;
--ifm-color-primary-light: #7089db;
--ifm-color-primary-lighter: #bfccf8;
--ifm-color-primary-lightest: #f5f7fe;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
--docusaurus-announcement-bar-height: auto !important;
}

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #7089DB;
--ifm-color-primary-darker: #7089DB;
--ifm-color-primary-darkest: #001A72;
--ifm-color-primary-light: #BFCCF8;
--ifm-color-primary-lightest: #F5F7FE;
[data-theme="dark"] {
--ifm-color-primary: #7089db;
--ifm-color-primary-darker: #7089db;
--ifm-color-primary-darkest: #001a72;
--ifm-color-primary-light: #bfccf8;
--ifm-color-primary-lightest: #f5f7fe;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

.navbar__title{
.navbar__title {
font-size: 1.5em;
}

0 comments on commit 1ee4dad

Please sign in to comment.