Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP redesign #552

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
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
179 changes: 58 additions & 121 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

// const lightCodeTheme = require('prism-react-renderer/themes/github');
// const darkCodeTheme = require('prism-react-renderer/themes/vsDark');
//import {themes as prismThemes} from 'prism-react-renderer';

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Logz.io Docs',
Expand All @@ -18,8 +14,8 @@ const config = {

// 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: 'logzio', // Usually your GitHub org/user name.
projectName: 'documentation', // Usually your repo name.

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
Expand All @@ -33,40 +29,14 @@ const config = {
},

plugins: [
'docusaurus-plugin-hotjar',
[
'docusaurus-plugin-includes',
{
sharedFolders: [
{ source: '../../_shared', target: '../docs/shared'},
{ source: '../../static/includes', target: '../docs/includes'}, // Added your shared folder here
],
postBuildDeletedFolders: ['shared'],
replacements: [
{ key: '{ProductName}', value: 'Logz.io' },
{ key: '{ShortName}', value: 'Logz' },
],
embeds: [
{
key: 'myAwesomePlugin',
embedFunction: function(code) {
return `...`; // Adjust according to your needs
}
}
],
injectedHtmlTags: {
preBodyTags: [`<link rel="stylesheet" href="https://cdn.example.com/style.css" type="text/css">`]
}
},
],
[
'@docusaurus/plugin-google-gtag',
{
trackingID: 'GTM-NH9MTDW',
anonymizeIP: true,
},
],
],
],

presets: [
[
Expand All @@ -77,15 +47,13 @@ const config = {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/logzio/documentation/tree/master',
editUrl: 'https://github.com/logzio/documentation/tree/master',
},
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/',
editUrl: 'https://github.com/logzio/documentation/tree/master',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
Expand All @@ -104,72 +72,38 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
algolia: {
// The application ID provided by Algolia
appId: 'GAVMESY4FI',

// Public API key: it is safe to commit it
apiKey: '7f9d22d433c66f1a108b092d02c8d034',

indexName: 'shiny-alfajores-ede8d8',

// Optional: see doc section below
contextualSearch: true,

// Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
externalUrlRegex: 'external\\.com|domain\\.com',



// Optional: Algolia search parameters
searchParameters: {},

// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',

//... other Algolia params
},
hotjar: {
applicationId: "3812613",
},
docs: {
sidebar: {
hideable: true,
autoCollapseCategories: true,
},
sidebar: {
hideable: true,
autoCollapseCategories: true,
},
},
// Replace with your project's social card
image: 'https://dytvr9ot2sszz.cloudfront.net/logz-docs/social-assets/docs-social.jpg',
navbar: {
title: 'Docs',
logo: {
alt: 'Logz.io Docs',
src: 'img/logz-logo.svg',
},
items: [
{ to: '/docs/category/user-guide/', label: 'Docs', position: 'left' },
{ to: 'https://logz.io/blog/', label: 'Blog', position: 'left' },
{ to: '/docs/category/send-your-data/', label: 'Ship data', position: 'left' },
{ to: 'https://status.logz.io/', label: 'System status', position: 'left' },
{ to: 'https://api-docs.logz.io/docs/logz/logz-io-api', label: 'API', position: 'left' },
{
type: 'search',
position: 'right',
},
{to: '/docs/category/send-your-data/', label: 'Ship data', position: 'left'},
{to: 'https://api-docs.logz.io/docs/logz/logz-io-api', label: 'API', position: 'left'},
{to: 'https://status.logz.io/', label: 'System status', position: 'left'},
{to: 'https://logz.io/blog/', label: 'Blog', position: 'left'},
{
href: 'https://logz.io/freetrial/?utm_medium=referral&utm_source=api-portal&utm_campaign=api_trial&utm_content=lp&utm_term=free+trial',
label: 'Get a Demo',
href: 'https://app.logz.io/',
label: 'Login',
position: 'right',
},
{
href: 'https://logz.io/freetrial/?utm_medium=referral&utm_source=docs-portal&utm_campaign=docs_trial&utm_content=lp&utm_term=free+trial',
label: 'Free Trial',
position: 'right',
},
{
href: 'https://app.logz.io/',
label: 'Login',
position: 'right',
},
],
},
tableOfContents: {
Expand All @@ -180,69 +114,66 @@ const config = {
style: 'dark',
links: [
{
title: 'Additional Links',
title: 'Resources',
items: [
{
label: 'Blog',
href: 'https://logz.io/blog/',
label: 'Link 1',
to: '/docs/link1',
},
{
label: 'Videos',
href: 'https://logz.io/learn/video/',
label: 'Link 2',
to: '/docs/link2',
},
{
label: 'Notices for 3rd Party Software included with the Logz.io Platform',
to: 'https://dytvr9ot2sszz.cloudfront.net/logz-docs/legal/3rd-party-software-included-with-the-logz.io-platform-sep-2022.pdf',
},
{
label: 'Report a security issue',
to: '/docs/user-guide/report-security-issue/',
label: 'Link 3',
to: '/docs/link3',
},
],
},
{
title: 'Legal',
title: 'Company',
items: [
{
label: 'Privacy Policy',
href: 'https://logz.io/about-us/privacy-policy/',
label: 'Link 4',
to: '/docs/link4',
},
{
label: 'Terms of Use',
href: 'https://logz.io/about-us/terms-of-use/',
label: 'Link 5',
to: '/docs/link5',
},
{
label: 'Sending Data to Logz.io',
href: '/docs/user-guide/admin/sending-data-to-logzio/',
label: 'Link 6',
to: '/docs/link6',
},
{
label: 'Trademark Legal Notice',
href: 'https://logz.io/about-us/trademarks-legal-notice/',
},
//{
// label: 'Contributers',
// to: 'https://docs.logz.io/credits.html',
//},
],
},
{
title: 'Social',
title: 'Contact',
items: [
{
label: 'Facebook',
href: 'https://www.facebook.com/logz.io',
label: 'Link 7',
to: '/docs/link7',
},
{
label: 'Twitter',
href: 'https://twitter.com/logzio',
label: 'Link 8',
to: '/docs/link8',
},
{
label: 'YouTube',
href: 'https://www.youtube.com/channel/UC9Rc1hpWHUju8O2rYHAUVXA',
label: 'Link 9',
to: '/docs/link9',
},
],
},
{
title: 'Follow Us',
items: [
{
label: 'Twitter',
href: 'https://twitter.com/logzio',
},
{
label: 'LinkedIn',
href: 'https://www.linkedin.com/company/4831888',
href: 'https://www.linkedin.com/company/logzio',
},
{
label: 'GitHub',
Expand All @@ -251,12 +182,18 @@ const config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Logshero Ltd.`,
copyright: `
<div class="footer__separator"></div>
<div class="footer__bottom">
<span class="footer__copyright">© ${new Date().getFullYear()} Logz.io. All rights reserved.</span>
<div class="footer__links-right">
<a href="/privacy">Privacy Policy</a>
<a href="/terms">Terms of Service</a>
<a href="/contact">Contact Us</a>
</div>
</div>
`,
},
// prism: {
// theme: prismThemes.github,
// darkTheme: prismThemes.dracula,
// },
}),
};

Expand Down
Loading