1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website/static
Thomas Heartman 6f4f8661c7
docs: update nav bar (#6045)
Update the Unleash docs navbar according to the new spec:

Changing "estimated time burden" to "estimated time" (or "estimated
reading time"), is just a matter of changing the text in the files.
There's nothing special making it say burden other than plain text. That
can be done in a follow-up PR.

The new nav bar includes the Unleash academy and certification dropdowns
as well as the docs and quickstart items. On smaller screen sizes
(between 997 and 1150 px), we hide the word "Unleash" from "Unleash
academy" and "Unleash certification".

The narrowest nav bar:

![image](https://github.com/Unleash/unleash/assets/17786332/13d05b0b-8668-4ff0-b06e-5c3073f0dda8)

When Unleash pops back in: 

![image](https://github.com/Unleash/unleash/assets/17786332/191ae3fe-5fca-4464-b79a-db6995e600c9)

---------

Co-authored-by: markunl <mark@getunleash.io>
2024-01-29 13:30:18 -05:00
..
img docs: update nav bar (#6045) 2024-01-29 13:30:18 -05:00
.nojekyll
CNAME docs: change CNAME for github pages to gh.getunleash.io 2024-01-09 10:27:56 +01:00
README.md
robots.txt docs: added robots.txt 2024-01-09 09:53:29 +01:00

The Unleash website was created with Docusaurus. The source code lives as part of the main Unleash repo on GitHub and is built and deployed on all merges to main. This makes it easy to keep the documentation in sync with the latest version of Unleash.

It's hosted on https://docs.getunleash.io

What's In This Document

Get Started in 5 Minutes

  1. Make sure all the dependencies for the website are installed:
# Install dependencies
$ npm install
  1. Run your dev server:
# Start the site
$ npm run start

Directory Structure

Your project file structure should look something like this

unleash/
  website/
    /docs
        doc-1.md
        doc-2.md
        doc-3.md
    static/
      css/
      img/
    package.json
    sidebar.json
    docusaurus.config.js

Editing Content

Editing an existing docs page

Edit docs by navigating to docs/ and editing the corresponding document:

docs/doc-to-be-edited.md

---
id: page-needs-edit
title: This Doc Needs To Be Edited
---

Edit me...

For more information about docs, click here

Adding Content

Adding a new docs page to an existing sidebar

  1. Create the doc as a new markdown file in /docs, example docs/newly-created-doc.md:
---
id: newly-created-doc
title: This Doc Needs To Be Edited
---

My new content here..
  1. Refer to that doc's ID in an existing sidebar in website/sidebars.json:
// Add newly-created-doc to the Getting Started category of docs
{
  "docs": {
    "Getting Started": [
      "quick-start",
      "newly-created-doc" // new doc here
    ],
    ...
  },
  ...
}

For more information about adding new docs, click here

Adding items to your site's top navigation bar

  1. Add links to docs, custom pages or external links by editing the headerLinks field of website/siteConfig.js:

website/siteConfig.js

{
  headerLinks: [
    ...
    /* you can add docs */
    { doc: 'my-examples', label: 'Examples' },
    /* you can add custom pages */
    { page: 'help', label: 'Help' },
    /* you can add external links */
    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
    ...
  ],
  ...
}

For more information about the navigation bar, click here

Full Documentation

Full documentation can be found on the website.