Skip to content

Commit 174a6af

Browse files
benhaynesbenhaynes
committed
Docs restructure
commit c59b4f9 Author: rijkvanzanten <[email protected]> Date: Fri Dec 7 11:10:01 2018 -0500 Upgrade theme commit a2392d1 Author: Ben Haynes <[email protected]> Date: Wed Dec 5 15:43:48 2018 -0500 clarify relation setup https://github.com/directus/app/issues/851 commit 0e59da2 Author: Ben Haynes <[email protected]> Date: Wed Dec 5 14:46:05 2018 -0500 Advanced ssection and theme commit def513f Author: Welling Guzman <[email protected]> Date: Wed Dec 5 10:03:22 2018 -0400 add some info to auth providers commit ded2c86 Author: Ben Haynes <[email protected]> Date: Tue Dec 4 21:08:05 2018 -0500 extensions commit 7167b66 Author: Ben Haynes <[email protected]> Date: Tue Dec 4 17:12:21 2018 -0500 sdk commit 8502195 Author: Ben Haynes <[email protected]> Date: Tue Dec 4 17:12:13 2018 -0500 guides commit 492ae6f Author: Ben Haynes <[email protected]> Date: Mon Dec 3 21:41:09 2018 -0500 no more theme commit d094856 Merge: b3db79f 4ce9937 Author: Ben Haynes <[email protected]> Date: Mon Dec 3 21:41:01 2018 -0500 Merge branch 'restructure' of https://github.com/directus/docs-v7 into restructure commit 4ce9937 Author: Rijk van Zanten <[email protected]> Date: Fri Nov 30 18:04:11 2018 -0500 Update troubleshooting.md commit 63c67e4 Author: Ben Haynes <[email protected]> Date: Fri Nov 30 17:30:35 2018 -0500 guide updates commit 3517417 Author: Ben Haynes <[email protected]> Date: Thu Nov 29 13:55:51 2018 -0500 intros and emoji commit 2acf6e6 Author: Ben Haynes <[email protected]> Date: Thu Nov 29 12:49:33 2018 -0500 landing page commit 76d2967 Author: Ben Haynes <[email protected]> Date: Thu Nov 29 12:46:15 2018 -0500 style and structure this style needs to be converted to a theme (no more !important) commit 3cf032a Author: Ben Haynes <[email protected]> Date: Wed Nov 28 20:53:58 2018 -0500 reorganization and remove theme commit b3db79f Author: Rijk van Zanten <[email protected]> Date: Fri Nov 30 18:04:11 2018 -0500 Update troubleshooting.md commit 927e4ce Author: Ben Haynes <[email protected]> Date: Fri Nov 30 17:30:35 2018 -0500 guide updates commit 2711ee0 Author: Ben Haynes <[email protected]> Date: Thu Nov 29 13:55:51 2018 -0500 intros and emoji commit 82cc728 Author: Ben Haynes <[email protected]> Date: Thu Nov 29 12:49:33 2018 -0500 landing page commit aca305d Author: Ben Haynes <[email protected]> Date: Thu Nov 29 12:46:15 2018 -0500 style and structure this style needs to be converted to a theme (no more !important) commit d346bc3 Author: Ben Haynes <[email protected]> Date: Wed Nov 28 20:53:58 2018 -0500 reorganization and remove theme
1 parent d0b1f03 commit 174a6af

File tree

183 files changed

+4287
-1914
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+4287
-1914
lines changed

‎.vuepress/config.js

+63-57
Original file line numberDiff line numberDiff line change
@@ -20,94 +20,100 @@ module.exports = {
2020
['meta', { name: "msapplication-config", content: "/browserconfig.xml" }]
2121
],
2222
themeConfig: {
23+
lastUpdated: 'Last Updated',
24+
repo: 'directus/docs',
25+
docsDir: '',
26+
editLinks: true,
27+
serviceWorker: true,
28+
hiddenLinks: [
29+
'/api-reference/reference.html',
30+
],
2331
nav: [
2432
{ text: 'Website', link: 'https://directus.io' },
2533
{ text: 'Cloud', link: 'https://directus.cloud' },
2634
{ text: 'Demo', link: 'https://directus.app' }
2735
],
2836
sidebarDepth: 1,
37+
// 🧠 📡 🤖 ✨ 💥 🔥 🌈 ⭐️ 🍄 🍹 🎱 🎨 🏆 🚨 🚀 💡 ⚙️ 🔮 🛠 🔑 🎁 🎈 🎀 ❤️ 💯
2938
sidebar: [
3039
{
31-
title: 'Introduction',
40+
title: '🐰 Getting Started',
41+
collapsable: false,
42+
children: [
43+
['/getting-started/introduction', 'Introduction'],
44+
['/getting-started/installation', 'Installation'],
45+
['/getting-started/concepts', 'Concepts'],
46+
['/getting-started/contributing', 'Contributing'],
47+
['/getting-started/supporting-directus', 'Supporting Directus'],
48+
['/getting-started/troubleshooting', 'Troubleshooting'],
49+
]
50+
},
51+
{
52+
title: '📖 Guides',
3253
collapsable: true,
3354
children: [
34-
'/what-is-directus',
35-
'/install',
36-
'/contributing',
37-
'/supporting-directus',
38-
'/docs-structure',
39-
'/i18n',
40-
'/glossary'
55+
'/guides/user-guide',
56+
'/guides/auth',
57+
'/guides/cli',
58+
'/guides/collections',
59+
'/guides/database',
60+
'/guides/fields',
61+
'/guides/field-types',
62+
['/guides/i18n', 'Internationalization'],
63+
'/guides/permissions',
64+
'/guides/relationships',
65+
'/guides/roles',
66+
'/guides/settings',
67+
'/guides/sso',
68+
'/guides/status',
69+
['/guides/style-guide', 'Style Guide'],
70+
'/guides/thumbnailer',
71+
'/guides/upgrading',
4172
]
4273
},
4374
{
44-
title: 'API',
75+
title: '🚀 API Reference',
4576
collapsable: true,
4677
children: [
47-
['/api/reference', 'API Reference'],
48-
['/', '┄┄┄┄┄┄┄┄┄┄'],
49-
['/api/admin/', 'Admin Guide'],
50-
['/api/admin/install', 'Installing'],
51-
['/api/admin/update', 'Updating'],
52-
['/api/admin/configure', 'Configuring'],
53-
['/api/admin/thumbnailer', 'Thumbnailer'],
54-
['/api/admin/field-types', 'Field Types'],
55-
['/api/admin/permissions', 'Permissions'],
56-
['/api/admin/global-settings', 'Global Settings'],
57-
['/', '┄┄┄┄┄┄┄┄┄┄'],
58-
['/api/contributor/', 'Contributor Guide'],
59-
['/api/contributor/install-dev', 'Development Environment'],
60-
['/api/contributor/cli', 'CLI'],
61-
['/api/contributor/codebase-overview', 'Codebase Overview'],
62-
['/api/contributor/database-overview', 'Database Overview'],
63-
['/api/contributor/resources', 'Resources'],
64-
['/api/contributor/troubleshooting', 'Troubleshooting']
78+
'/api-reference/reference',
6579
]
6680
},
6781
{
68-
title: 'Application',
82+
title: '⚡️ SDKs',
6983
collapsable: true,
7084
children: [
71-
['/app/user-guide', 'User Guide'],
72-
['/', '┄┄┄┄┄┄┄┄┄┄'],
73-
['/app/admin/', 'Admin Guide'],
74-
['/app/admin/install', 'Installing'],
75-
['/app/admin/update', 'Updating'],
76-
['/app/admin/troubleshooting', 'Troubleshooting'],
77-
['/app/admin/collections', 'Collections'],
78-
['/app/admin/fields', 'Fields'],
79-
['/app/admin/relationships', 'Relationships'],
80-
['/app/admin/status', 'Status'],
81-
['/app/admin/roles', 'Roles'],
82-
['/app/admin/permissions', 'Permissions'],
83-
['/', '┄┄┄┄┄┄┄┄┄┄'],
84-
['/app/contributor/', 'Contributor Guide'],
85-
['/app/contributor/install-dev', 'Development Environment'],
86-
['/app/contributor/helpers', 'Helpers'],
87-
['/app/contributor/i18n', 'Internationalization'],
88-
['/app/contributor/resources', 'Resources'],
89-
['/app/contributor/troubleshooting', 'Troubleshooting']
85+
['/sdk/js', 'Javascript'],
9086
]
9187
},
9288
{
93-
title: 'Extending Directus',
89+
title: '🦄 Extensions',
9490
collapsable: true,
9591
children: [
9692
['/extensions/', 'Introduction'],
97-
'/extensions/architecture',
93+
'/extensions/auth-providers',
94+
'/extensions/custom-endpoints',
95+
'/extensions/hooks',
9896
'/extensions/interfaces',
9997
'/extensions/layouts',
10098
'/extensions/pages',
101-
'/extensions/hooks',
102-
'/extensions/custom-endpoints',
10399
'/extensions/storage-adapters',
104-
'/extensions/auth-providers'
100+
]
101+
},
102+
{
103+
title: '🚧 Advanced',
104+
collapsable: true,
105+
children: [
106+
['/advanced/other-install-methods', 'Other Install Methods'],
107+
['/advanced/source', 'Local Dev Environment'],
108+
['/advanced/server-setup', 'Server Setup'],
109+
['/advanced/app/standalone', 'Application Standalone Install'],
110+
['/advanced/app/configuration', 'Application Configuration'],
111+
['/advanced/api/standalone', 'API Standalone Install'],
112+
['/advanced/api/configuration', 'API Configuration'],
113+
['/advanced/api/codebase', 'API Codebase'],
114+
// ['/advanced/deploying-versions', 'Deploying Versions'],
105115
]
106116
}
107-
],
108-
lastUpdated: 'Last Updated',
109-
repo: 'directus/docs',
110-
docsDir: '',
111-
editLinks: true
117+
]
112118
}
113119
};

‎.vuepress/styles/index.styl

+21
Original file line numberDiff line numberDiff line change
@@ -139,3 +139,24 @@ thead {
139139
// margin-top: -2.0rem !important;
140140
// padding-top: 4.6rem;
141141
}
142+
143+
//////////////////////////////////////////////////////////////////////////////
144+
145+
blockquote {
146+
font-size: 1.3rem !important;
147+
margin-top: 2rem !important;
148+
margin-bottom: 2rem !important;
149+
}
150+
151+
h1, h2, h3, h4, h5, h6 {
152+
.content:not(.custom) > & {
153+
padding-top: 4.6rem !important;
154+
margin-top: -3rem !important;
155+
&:first-child {
156+
margin-top 1rem !important;
157+
+ p, + pre, + .custom-block {
158+
margin-top 2rem !important;
159+
}
160+
}
161+
}
162+
}

‎.vuepress/theme/components/AlgoliaSearchBox.vue

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
<template>
2+
<form
3+
id="search-form"
4+
class="algolia-search-wrapper search-box"
5+
>
6+
<input
7+
id="algolia-search-input"
8+
class="search-query"
9+
>
10+
</form>
11+
</template>
12+
13+
<script>
14+
export default {
15+
props: ['options'],
16+
17+
mounted () {
18+
this.initialize(this.options, this.$lang)
19+
},
20+
21+
methods: {
22+
initialize (userOptions, lang) {
23+
Promise.all([
24+
import(/* webpackChunkName: "docsearch" */ 'docsearch.js/dist/cdn/docsearch.min.js'),
25+
import(/* webpackChunkName: "docsearch" */ 'docsearch.js/dist/cdn/docsearch.min.css')
26+
]).then(([docsearch]) => {
27+
docsearch = docsearch.default
28+
const { algoliaOptions = {}} = userOptions
29+
docsearch(Object.assign(
30+
{},
31+
userOptions,
32+
{
33+
inputSelector: '#algolia-search-input',
34+
// #697 Make docsearch work well at i18n mode.
35+
algoliaOptions: Object.assign({
36+
'facetFilters': [`lang:${lang}`].concat(algoliaOptions.facetFilters || [])
37+
}, algoliaOptions)
38+
}
39+
))
40+
})
41+
},
42+
43+
update (options, lang) {
44+
this.$el.innerHTML = '<input id="algolia-search-input" class="search-query">'
45+
this.initialize(options, lang)
46+
}
47+
},
48+
49+
watch: {
50+
$lang (newValue) {
51+
this.update(this.options, newValue)
52+
},
53+
54+
options (newValue) {
55+
this.update(newValue, this.$lang)
56+
}
57+
}
58+
}
59+
</script>
60+
61+
<style lang="stylus">
62+
.algolia-search-wrapper
63+
& > span
64+
vertical-align middle
65+
.algolia-autocomplete
66+
line-height normal
67+
.ds-dropdown-menu
68+
background-color #fff
69+
border 1px solid #999
70+
border-radius 4px
71+
font-size 16px
72+
margin 6px 0 0
73+
padding 4px
74+
text-align left
75+
&:before
76+
border-color #999
77+
[class*=ds-dataset-]
78+
border none
79+
padding 0
80+
.ds-suggestions
81+
margin-top 0
82+
.ds-suggestion
83+
border-bottom 1px solid $borderColor
84+
.algolia-docsearch-suggestion--highlight
85+
color #2c815b
86+
.algolia-docsearch-suggestion
87+
border-color $borderColor
88+
padding 0
89+
.algolia-docsearch-suggestion--category-header
90+
padding 5px 10px
91+
margin-top 0
92+
background $accentColor
93+
color #fff
94+
font-weight 600
95+
.algolia-docsearch-suggestion--highlight
96+
background rgba(255, 255, 255, 0.6)
97+
.algolia-docsearch-suggestion--wrapper
98+
padding 0
99+
.algolia-docsearch-suggestion--title
100+
font-weight 600
101+
margin-bottom 0
102+
color $textColor
103+
.algolia-docsearch-suggestion--subcategory-column
104+
vertical-align top
105+
padding 5px 7px 5px 5px
106+
border-color $borderColor
107+
background #f1f3f5
108+
&:after
109+
display none
110+
.algolia-docsearch-suggestion--subcategory-column-text
111+
color #555
112+
.algolia-docsearch-footer
113+
border-color $borderColor
114+
.ds-cursor .algolia-docsearch-suggestion--content
115+
background-color #e7edf3 !important
116+
color $textColor
117+
118+
@media (min-width: $MQMobile)
119+
.algolia-search-wrapper
120+
.algolia-autocomplete
121+
.algolia-docsearch-suggestion
122+
.algolia-docsearch-suggestion--subcategory-column
123+
float none
124+
width 150px
125+
min-width 150px
126+
display table-cell
127+
.algolia-docsearch-suggestion--content
128+
float none
129+
display table-cell
130+
width 100%
131+
vertical-align top
132+
.ds-dropdown-menu
133+
min-width 515px !important
134+
135+
@media (max-width: $MQMobile)
136+
.algolia-search-wrapper
137+
.ds-dropdown-menu
138+
min-width calc(100vw - 4rem) !important
139+
max-width calc(100vw - 4rem) !important
140+
.algolia-docsearch-suggestion--wrapper
141+
padding 5px 7px 5px 5px !important
142+
.algolia-docsearch-suggestion--subcategory-column
143+
padding 0 !important
144+
background white !important
145+
.algolia-docsearch-suggestion--subcategory-column-text:after
146+
content " > "
147+
font-size 10px
148+
line-height 14.4px
149+
display inline-block
150+
width 5px
151+
margin -3px 3px 0
152+
vertical-align middle
153+
154+
</style>

0 commit comments

Comments
 (0)