Skip to content

Commit 85ccad6

Browse files
committed
website: more rework with commons
1 parent 7328893 commit 85ccad6

File tree

16 files changed

+64
-55
lines changed

16 files changed

+64
-55
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
[![license](https://img.shields.io/github/license/xpack/xpack.github.io)](https://github.com/xpack/xpack.github.io/blob/website/LICENSE)
23

34
# The xPack Project web site source

website/docs/developer/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,3 @@ import ProjectContent from './_project/_content.mdx';
2020
{/* ------------------------------------------------------------------------ */}
2121

2222
<ProjectContent />
23-

website/docs/getting-started/_common/_license.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,3 @@ The original content is released under the
99
[MIT License](https://opensource.org/license/mit/),
1010
with all rights reserved to
1111
[Liviu Ionescu](https://github.com/ilg-ul).
12-

website/docs/getting-started/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,3 @@ import ProjectContent from './_project/_content.mdx';
2222
# Getting started with the xPack Project
2323

2424
<ProjectContent />
25-

website/docs/maintainer/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,3 @@ import ProjectContent from './_project/_content.mdx';
1919
{/* ------------------------------------------------------------------------ */}
2020

2121
<ProjectContent />
22-

website/docs/project/about/_common/_the-author.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ a senior computer engineer, with expertise in **C++/C embedded systems**,
1111
**RTOSes**, **build tools**, operating systems, compilers
1212
and Internet technologies.
1313

14-
1514
He can be reached at [`<[email protected]>`](mailto:[email protected]).
1615
Please note, this email address is provided as a courtesy.
1716
For all correspondence related to the

website/docs/project/about/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,3 @@ import ProjectContent from './_project/_content.mdx';
2424
# About the xPack Project
2525

2626
<ProjectContent />
27-

website/docs/support/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ please share them through the
3838
GitHub Discussions pages. Use the top-level
3939
[GitHub Discussions](https://github.com/xpack/xpack.github.io/discussions)
4040
page for issues related to the main xPack Project site, or the individual project's GitHub Discussions pages for specific projects.
41+
4142
## Check documentation
4243

4344
As usual, before asking anything, it is a good idea to check the project
@@ -53,7 +54,7 @@ check if the subject was not already addressed.
5354

5455
- Check the GitHub Discussions for
5556
similar topics
56-
- Check the
57+
- Check the
5758
GitHub Issues
5859
tracker and the
5960
GitHub Pull Requests

website/docs/user/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,3 @@ import ProjectContent from './_project/_content.mdx';
2020
{/* ------------------------------------------------------------------------ */}
2121

2222
<ProjectContent />
23-

website/docusaurus.config.ts

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,24 @@ import {getCustomFields} from './customFields';
2020
const customFields = getCustomFields();
2121
console.log('customFields: ' + util.inspect(customFields));
2222

23+
const actualBaseUrl = process.env.DOCUSAURUS_BASEURL ??
24+
'/';
25+
2326
// ----------------------------------------------------------------------------
2427

2528
const config: Config = {
2629
title: 'The xPack Reproducible Build Framework' +
2730
((process.env.DOCUSAURUS_IS_PREVIEW === 'true') ? ' (preview)' : ''),
2831
tagline: 'Tools to manage, configure and build complex, package based, multi-target projects, in a reproducible way',
32+
2933
// Explicitly set in headTags.
3034
// favicon: '/img/favicon.ico',
3135

3236
// Set the production url of your site here
3337
url: 'https://xpack.github.io/',
3438
// Set the /<baseUrl>/ pathname under which your site is served
3539
// For GitHub pages deployment, it is often '/<projectName>/'
36-
baseUrl: process.env.DOCUSAURUS_BASEURL ??
37-
'/',
40+
baseUrl: actualBaseUrl,
3841

3942
// GitHub pages deployment config.
4043
// If you aren't using GitHub pages, you don't need these.
@@ -66,7 +69,7 @@ const config: Config = {
6669
sidebarPath: './sidebars.ts',
6770
// Please change this to your repo.
6871
// Remove this to remove the "edit this page" links.
69-
editUrl: 'https://github.com/xpack/xpack.github.io/edit/master/website/',
72+
editUrl: 'https://github.com/xpack/xpack.github.io/edit/website/website/',
7073
// showLastUpdateAuthor: true,
7174
showLastUpdateTime: true,
7275
},
@@ -76,13 +79,14 @@ const config: Config = {
7679
'@docusaurus/plugin-content-blog',
7780
{
7881
showReadingTime: true,
82+
blogSidebarCount: 8,
7983
feedOptions: {
8084
type: ['rss', 'atom'],
8185
xslt: true,
8286
},
8387
// Please change this to your repo.
8488
// Remove this to remove the "edit this page" links.
85-
editUrl: 'https://github.com/xpack/xpack.github.io/edit/master/website/',
89+
editUrl: 'https://github.com/xpack/xpack.github.io/edit/website/website/',
8690
// Useful options to enforce blogging best practices
8791
onInlineTags: 'warn',
8892
onInlineAuthors: 'warn',
@@ -115,10 +119,14 @@ const config: Config = {
115119
// https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap
116120
'@docusaurus/plugin-sitemap',
117121
{
118-
// https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap
122+
lastmod: 'date',
119123
changefreq: 'weekly',
120124
priority: 0.5,
121-
// ignorePatterns: ['/tags/**'],
125+
ignorePatterns: [
126+
actualBaseUrl + 'blog/archive/**',
127+
actualBaseUrl + 'blog/authors/**',
128+
actualBaseUrl + 'blog/tags/**'
129+
],
122130
filename: 'sitemap.xml',
123131
}
124132
],
@@ -145,6 +153,7 @@ const config: Config = {
145153
}
146154
],
147155
[
156+
// Explicitly required when not using `preset-classic`.
148157
// https://docusaurus.io/docs/search#using-algolia-docsearch
149158
'@docusaurus/theme-search-algolia',
150159
{
@@ -159,7 +168,7 @@ const config: Config = {
159168
attributes: {
160169
rel: 'icon',
161170
type: 'image/png',
162-
href: '/favicons/favicon-48x48.png',
171+
href: actualBaseUrl + 'favicons/favicon-48x48.png',
163172
sizes: '48x48'
164173
}
165174
},
@@ -168,14 +177,14 @@ const config: Config = {
168177
attributes: {
169178
rel: 'icon',
170179
type: 'image/svg+xml',
171-
href: '/favicons/favicon.svg'
180+
href: actualBaseUrl + 'favicons/favicon.svg'
172181
}
173182
},
174183
{
175184
tagName: 'link',
176185
attributes: {
177186
rel: 'shortcut icon',
178-
href: '/favicons/favicon.ico'
187+
href: actualBaseUrl + 'favicons/favicon.ico'
179188
}
180189
},
181190
{
@@ -190,14 +199,12 @@ const config: Config = {
190199
tagName: 'link',
191200
attributes: {
192201
rel: 'manifest',
193-
href: '/favicons/site.webmanifest'
202+
href: actualBaseUrl + 'favicons/site.webmanifest'
194203
}
195204
}
196205
],
197206

198-
// No longer needed.
199-
// themes: [ '@docusaurus/theme-search-algolia' ],
200-
207+
// https://docusaurus.io/docs/seo
201208
themeConfig: {
202209
// The project's social card, og:image, twitter:image, 1200x630
203210
image: 'img/sunrise-og-image.jpg',
@@ -214,7 +221,7 @@ const config: Config = {
214221
logo: {
215222
alt: 'xPack Logo',
216223
src: 'img/components-256.png',
217-
href: 'https://xpack.github.io/',
224+
href: 'https://xpack.github.io/'
218225
},
219226
items: [
220227
{
@@ -252,7 +259,7 @@ const config: Config = {
252259
{
253260
label: 'About',
254261
to: '/docs/project/about'
255-
}
262+
},
256263
],
257264
},
258265
{
@@ -313,6 +320,10 @@ const config: Config = {
313320
label: 'Getting Started',
314321
to: '/docs/getting-started',
315322
},
323+
{
324+
label: 'Support',
325+
to: '/docs/support',
326+
},
316327
{
317328
label: 'About',
318329
to: '/docs/project/about',

0 commit comments

Comments
 (0)