Skip to content

docs(web): add description for #theme/Footer and #theme/Metabar #765

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.

Sign up for GitHub

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

Open
TusharThakur04 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −6
Open

docs(web): add description for #theme/Footer and #theme/Metabar #765

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions src/generators/web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,14 @@ The `web` generator accepts the following configuration options:

#### Default `imports`

| Alias | Default | Description |
| ------------------- | -------------------------------------------- | -------------------------------------------- |
| `#theme/Logo` | `@node-core/ui-components/Common/NodejsLogo` | Logo rendered inside the navigation bar |
| `#theme/Navigation` | Built-in `NavBar` component | Top navigation bar |
| `#theme/Sidebar` | Built-in `SideBar` component | Sidebar with version selector and page links |
| `#theme/Layout` | Built-in `Layout` component | Outermost wrapper around the full page |
| Alias | Default | Description |
| ------------------- | -------------------------------------------- | --------------------------------------------------- |
| `#theme/Logo` | `@node-core/ui-components/Common/NodejsLogo` | Logo rendered inside the navigation bar |
| `#theme/Navigation` | Built-in `NavBar` component | Top navigation bar |
| `#theme/Sidebar` | Built-in `SideBar` component | Sidebar with version selector and page links |
| `#theme/Metabar` | Built-in `MetaBar` component | Metadata bar displayed alongside page content |
| `#theme/Footer` | Built-in `NoOp` component (renders nothing) | Optional footer rendered at the bottom of each page |
| `#theme/Layout` | Built-in `Layout` component | Outermost wrapper around the full page |

Override any alias in your config file to swap in a custom component:

Expand Down
Loading