mirror of
https://github.com/logto-io/logto.git
synced 2025-03-31 22:51:25 -05:00
refactor(docs): reorg files
This commit is contained in:
parent
0ac501173e
commit
f0b06d4fd7
29 changed files with 75 additions and 19 deletions
1
.vscode/settings.json
vendored
1
.vscode/settings.json
vendored
|
@ -26,6 +26,7 @@
|
|||
"codecov",
|
||||
"Logto",
|
||||
"oidc",
|
||||
"passcode",
|
||||
"Passwordless",
|
||||
"pnpm",
|
||||
"silverhand",
|
||||
|
|
|
@ -41,7 +41,7 @@ In your terminal:
|
|||
node -e "$(printf "%s" "$(curl -fsSL https://raw.githubusercontent.com/logto-io/logto/master/install.js)")"
|
||||
```
|
||||
|
||||
The script will download Logto and create a directory `logto` in the location you ran it. After answering [several simple questions](./tutorial/configuration#questions), you will see the message like:
|
||||
The script will download Logto and create a directory `logto` in the location you ran it. After answering [several simple questions](./docs/references/core/configuration#questions), you will see the message like:
|
||||
|
||||
```bash
|
||||
App is running at http://localhost:3001
|
||||
|
@ -55,4 +55,4 @@ TBD
|
|||
|
||||
## Configuration
|
||||
|
||||
Logto uses environment variables for configuration, along with `.env` file support. See [Configuration](./tutorial/configuration) for detailed usage and full variable list.
|
||||
Logto uses environment variables for configuration, along with `.env` file support. See [Configuration](./docs/references/core/configuration) for detailed usage and full variable list.
|
1
packages/docs/docs/docs/references/core/README.md
Normal file
1
packages/docs/docs/docs/references/core/README.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Core
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Get Started
|
||||
|
||||
Before we start, it'll be good to know how Logto works. To simplify, we divide Logto into four parts: Admin Console, Sign-in Experience, Core Service, and SDKs.
|
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"collapsible": false,
|
||||
"collapsed": false
|
||||
}
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Add a social connector
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Customize sign-in experience
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Enable SMS or email passcode sign-in
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Further readings
|
|
@ -46,7 +46,7 @@ const config = {
|
|||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||
({
|
||||
navbar: {
|
||||
title: 'Logto Docs',
|
||||
title: 'Logto',
|
||||
logo: {
|
||||
alt: 'Logto Logo',
|
||||
src: 'img/logo.svg',
|
||||
|
@ -54,9 +54,9 @@ const config = {
|
|||
items: [
|
||||
{
|
||||
type: 'doc',
|
||||
docId: 'tutorial/README',
|
||||
docId: 'docs/README',
|
||||
position: 'left',
|
||||
label: 'Tutorial',
|
||||
label: 'Docs',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
|
@ -88,7 +88,7 @@ const config = {
|
|||
title: 'Docs',
|
||||
items: [
|
||||
{
|
||||
label: 'Tutorial',
|
||||
label: 'Docs',
|
||||
to: '/',
|
||||
},
|
||||
],
|
||||
|
|
|
@ -2,25 +2,25 @@
|
|||
"version.label": {
|
||||
"message": "下一个"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.Integrate SDK": {
|
||||
"sidebar.docsSidebar.category.Integrate SDK": {
|
||||
"message": "集成 SDK"
|
||||
},
|
||||
"sidebar.sdkSidebar.category.Classes": {
|
||||
"sidebar.docsSidebar.category.Classes": {
|
||||
"message": "类(Classes)"
|
||||
},
|
||||
"sidebar.sdkSidebar.category.Enums": {
|
||||
"sidebar.docsSidebar.category.Enums": {
|
||||
"message": "枚举(Enums)"
|
||||
},
|
||||
"sidebar.sdkSidebar.category.Protocols": {
|
||||
"sidebar.docsSidebar.category.Protocols": {
|
||||
"message": "接口(Protocols)"
|
||||
},
|
||||
"sidebar.sdkSidebar.category.Typealiases": {
|
||||
"sidebar.docsSidebar.category.Typealiases": {
|
||||
"message": "类型别名(Typealiases)"
|
||||
},
|
||||
"sidebar.sdkSidebar.category.Extensions": {
|
||||
"sidebar.docsSidebar.category.Extensions": {
|
||||
"message": "扩展(Extensions)"
|
||||
},
|
||||
"sidebar.sdkSidebar.category.Structs": {
|
||||
"sidebar.docsSidebar.category.Structs": {
|
||||
"message": "结构体(Structs)"
|
||||
}
|
||||
}
|
||||
|
|
|
@ -14,8 +14,28 @@
|
|||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
tutorialSidebar: [{type: 'autogenerated', dirName: 'tutorial'}],
|
||||
sdkSidebar: [{type: 'autogenerated', dirName: 'sdk'}],
|
||||
docsSidebar: [
|
||||
{
|
||||
type: 'html',
|
||||
value: 'Tutorials',
|
||||
className: 'sidebar-section',
|
||||
},
|
||||
'docs/README',
|
||||
{ type: 'autogenerated', dirName: 'docs/tutorials' },
|
||||
{
|
||||
type: 'html',
|
||||
value: 'Recipes',
|
||||
className: 'sidebar-section',
|
||||
},
|
||||
{ type: 'autogenerated', dirName: 'docs/recipes' },
|
||||
{
|
||||
type: 'html',
|
||||
value: 'References',
|
||||
className: 'sidebar-section',
|
||||
},
|
||||
{ type: 'autogenerated', dirName: 'docs/references' },
|
||||
],
|
||||
sdkSidebar: [{ type: 'autogenerated', dirName: 'sdk' }],
|
||||
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
|
|
|
@ -15,6 +15,7 @@
|
|||
--ifm-color-primary-lightest: #3cad6e;
|
||||
--ifm-code-font-size: 95%;
|
||||
--doc-sidebar-width: 450px !important;
|
||||
--doc-sidebar-section-title: #eee;
|
||||
}
|
||||
|
||||
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
||||
|
@ -26,6 +27,7 @@
|
|||
--ifm-color-primary-light: #29d5b0;
|
||||
--ifm-color-primary-lighter: #32d8b4;
|
||||
--ifm-color-primary-lightest: #4fddbf;
|
||||
--doc-sidebar-section-title: #777;
|
||||
}
|
||||
|
||||
.docusaurus-highlight-code-line {
|
||||
|
@ -38,3 +40,15 @@
|
|||
[data-theme='dark'] .docusaurus-highlight-code-line {
|
||||
background-color: rgba(0, 0, 0, 0.3);
|
||||
}
|
||||
|
||||
.sidebar-section {
|
||||
color: var(--doc-sidebar-section-title);
|
||||
padding: var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal);
|
||||
text-transform: uppercase;
|
||||
font-size: 14px;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.sidebar-section:not(:first-child) {
|
||||
margin-top: calc(var(--ifm-menu-link-padding-vertical) * 2);
|
||||
}
|
||||
|
|
Loading…
Add table
Reference in a new issue