UCOMmandIt
/
uci-hugo-doc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

setup prettier

uci-hugo-doc
Robert Kaussow 2020-09-10 22:23:24 +02:00
parent 9f61dc7684
commit a81f858848
No known key found for this signature in database
GPG Key ID: 65362AE74AF98B61
19 changed files with 239 additions and 177 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/settings.yml vendored
View File

@ -57,5 +57,3 @@ branches:
restrictions:
users: []
teams: []
...

8
.prettierignore Normal file
View File

@ -0,0 +1,8 @@
*.html
.drone.yml
search*.js
_normalize.css
.lighthouseci/
themes/
static/js/
src/favicon/

10
.prettierrc Normal file
View File

@ -0,0 +1,10 @@
{
"overrides": [
{
"files": ["*.html"],
"options": {
"parser": "go-template"
}
}
]
}

2
exampleSite/content/shortcodes/buttons.md
View File

@ -8,6 +8,8 @@ Buttons are styled links that can lead to local page or external link.
## Example
<!-- spellchecker-disable -->
{{< button relref="/" >}}Get Home{{< /button >}}
{{< button href="https://github.com/xoxys/hugo-geekdoc" >}}Contribute{{< /button >}}
<!-- spellchecker-enable -->

11
exampleSite/content/shortcodes/includes.md
View File

@ -8,6 +8,7 @@ Include shortcode can include files of different types. By specifying a language
Attributes:
<!-- prettier-ignore -->
| Name | Usage | default |
|---|---|---|
| file | path to the included file relative to the hugo root | empty value |
@ -17,17 +18,19 @@ Attributes:
\* if not set, the content will be rendered as plain HTML
### Include *.yml file with options
### Include \*.yml file with options
```tpl
{{</* include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100" */>}}
```
<!-- spellchecker-disable -->
{{< include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100">}}
<!-- spellchecker-enable -->
### Include *.md file
### Include \*.md file
Included markdown files will be rendered using the `markdownify` filter.
@ -41,10 +44,12 @@ If you include markdown files that should not get a menu entry, place them outsi
```
<!-- spellchecker-disable -->
{{< include file="static/includes/table.md.part" markdown="true" >}}
<!-- spellchecker-enable -->
### Include *.html file
### Include \*.html file
HTML content will be filtered by the `safeHTML` filter and added to the rendered page output.

3
exampleSite/content/shortcodes/mermaid.md
View File

@ -4,6 +4,7 @@
{{< columns >}}
<!-- prettier-ignore -->
```tpl
{{</* mermaid class="text-center"*/>}}
sequenceDiagram
@ -22,6 +23,7 @@ sequenceDiagram
<--->
<!-- spellchecker-disable -->
<!-- prettier-ignore -->
{{< mermaid class="text-center" >}}
sequenceDiagram
Alice->>Bob: Hello Bob, how are you?
@ -34,6 +36,7 @@ sequenceDiagram
Bob->>Alice: Thanks for asking
end
{{< /mermaid >}}
<!-- spellchecker-enable -->
{{< /columns >}}

2
exampleSite/content/shortcodes/tabs.md
View File

@ -30,7 +30,7 @@ fastidious copious quo ad. Stet probates in duo.
This is tab **Linux** content.
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates
investiture. __Ornateness__ bland it ex enc, est yeti am bongo detract re. Pro ad
investiture. **Ornateness** bland it ex enc, est yeti am bongo detract re. Pro ad
prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim
fastidious copious quo ad. Stet probates in duo.
{{< /tab >}}

2
exampleSite/content/shortcodes/toc.md
View File

@ -5,7 +5,9 @@ Simple wrapper to generate a page Table of Content from a shortcode.
```
<!-- spellchecker-disable -->
{{< toc >}}
<!-- spellchecker-enable -->
## Level 1

2
exampleSite/content/toc-tree/_index.md
View File

@ -6,5 +6,7 @@ geekdocFlatSection: true
This is just a demo section for the <!-- spellchecker-disable -->[toc-tree](/shortcodes/toc-tree/)<!-- spellchecker-enable --> shortcode.
<!-- spellchecker-disable -->
{{< toc-tree >}}
<!-- spellchecker-enable -->

2
exampleSite/content/toc-tree/level-1/_index.md
View File

@ -1,5 +1,7 @@
Level 1
<!-- spellchecker-disable -->
{{< toc-tree >}}
<!-- spellchecker-enable -->

2
exampleSite/content/toc-tree/level-1/level-1-3/_index.md
View File

@ -5,5 +5,7 @@ title: Level 1.3
Level 1.3
<!-- spellchecker-disable -->
{{< toc-tree >}}
<!-- spellchecker-enable -->

5
exampleSite/content/usage/code_blocks.md
View File

@ -67,6 +67,7 @@ pygmentsCodeFences: true
You can use it like every other shortcode:
<!-- prettier-ignore -->
```markdown
{{</* highlight Shell "linenos=table" */>}}
# some code
@ -77,8 +78,12 @@ echo "Hello World"
**Example:**
<!-- markdownlint-disable -->
<!-- prettier-ignore-start -->
{{< highlight Shell "linenos=table" >}}
# some code
echo "Hello World"
{{< /highlight >}}
<!-- prettier-ignore-end-->
<!-- markdownlint-enable -->

4
exampleSite/content/usage/color_schemes.md
View File

@ -4,6 +4,8 @@ All necessary class names are listed below. If you miss some classes required fo
<!-- markdownlint-disable -->
<!-- spellchecker-disable -->
<!-- prettier-ignore-start -->
{{< highlight CSS "linenos=table" >}}
/* default link color */
a { color: #1c388e; }
@ -32,6 +34,8 @@ a:visited { color: #73bfb8 }
.gdoc-hint.warning { background: #fef5dc; border-color: #e4ba48; color: black; }
.gdoc-hint.danger { background: #fae1db; border-color: #cf5f46; color: black; }
{{< /highlight >}}
<!-- prettier-ignore-end -->
<!-- spellchecker-enable -->
<!-- markdownlint-enable -->

175
gulpfile.js
View File

@ -1,99 +1,105 @@
const gulp = require('gulp');
const rename = require('gulp-rename');
const sass = require('gulp-sass');
const cleanCSS = require('gulp-clean-css');
const autoprefixer = require('gulp-autoprefixer');
const iconfont = require('gulp-iconfont');
const gulp = require("gulp");
const rename = require("gulp-rename");
const sass = require("gulp-sass");
const cleanCSS = require("gulp-clean-css");
const autoprefixer = require("gulp-autoprefixer");
const iconfont = require("gulp-iconfont");
const realFavicon = require('gulp-real-favicon');
const path = require('path');
const fs = require('fs');
const realFavicon = require("gulp-real-favicon");
const path = require("path");
const fs = require("fs");
const svgSprite = require('gulp-svg-sprite');
const svgSprite = require("gulp-svg-sprite");
var CSSDEST = 'static/'
var FAVICON_DATA_FILE = 'src/favicon/faviconData.json';
var CSSDEST = "static/";
var FAVICON_DATA_FILE = "src/favicon/faviconData.json";
var TIMESTAMP = Math.round(Date.now() / 1000);
gulp.task('sass', function () {
return gulp.src('src/sass/main.scss')
gulp.task("sass", function () {
return gulp
.src("src/sass/main.scss")
.pipe(sass({ errLogToConsole: true }))
.pipe(cleanCSS({ format: 'beautify' }))
.pipe(autoprefixer({
cascade: false
}))
.pipe(cleanCSS({ format: "beautify" }))
.pipe(
autoprefixer({
cascade: false,
})
)
.pipe(gulp.dest(CSSDEST))
.pipe(cleanCSS())
.pipe(rename({ extname: '.min.css' }))
.pipe(gulp.dest(CSSDEST))
.pipe(rename({ extname: ".min.css" }))
.pipe(gulp.dest(CSSDEST));
});
gulp.task('favicon-generate', function (done) {
realFavicon.generateFavicon({
masterPicture: 'src/favicon/favicon-master.svg',
dest: 'static/favicon',
iconsPath: '/',
gulp.task("favicon-generate", function (done) {
realFavicon.generateFavicon(
{
masterPicture: "src/favicon/favicon-master.svg",
dest: "static/favicon",
iconsPath: "/",
design: {
ios: {
pictureAspect: 'backgroundAndMargin',
backgroundColor: '#ffffff',
margin: '14%',
pictureAspect: "backgroundAndMargin",
backgroundColor: "#ffffff",
margin: "14%",
assets: {
ios6AndPriorIcons: false,
ios7AndLaterIcons: false,
precomposedIcons: false,
declareOnlyDefaultIcon: true
}
declareOnlyDefaultIcon: true,
},
},
desktopBrowser: {},
windows: {
pictureAspect: 'whiteSilhouette',
backgroundColor: '#2b5797',
onConflict: 'override',
pictureAspect: "whiteSilhouette",
backgroundColor: "#2b5797",
onConflict: "override",
assets: {
windows80Ie10Tile: false,
windows10Ie11EdgeTiles: {
small: false,
medium: true,
big: false,
rectangle: false
}
}
rectangle: false,
},
},
},
androidChrome: {
pictureAspect: 'shadow',
themeColor: '#ffffff',
pictureAspect: "shadow",
themeColor: "#ffffff",
manifest: {
display: 'standalone',
orientation: 'notSet',
onConflict: 'override',
declared: true
display: "standalone",
orientation: "notSet",
onConflict: "override",
declared: true,
},
assets: {
legacyIcon: false,
lowResolutionIcons: false
}
lowResolutionIcons: false,
},
},
safariPinnedTab: {
pictureAspect: 'blackAndWhite',
pictureAspect: "blackAndWhite",
threshold: 74.21875,
themeColor: '#5bbad5'
}
themeColor: "#5bbad5",
},
},
settings: {
scalingAlgorithm: 'Mitchell',
scalingAlgorithm: "Mitchell",
errorOnImageTooSmall: false,
readmeFile: false,
htmlCodeFile: false,
usePathAsIs: false
usePathAsIs: false,
},
markupFile: FAVICON_DATA_FILE
}, function () {
markupFile: FAVICON_DATA_FILE,
},
function () {
done();
});
}
);
});
gulp.task('favicon-check-update', function (done) {
gulp.task("favicon-check-update", function (done) {
var currentVersion = JSON.parse(fs.readFileSync(FAVICON_DATA_FILE)).version;
realFavicon.checkForUpdates(currentVersion, function (err) {
if (err) {
@ -103,32 +109,33 @@ gulp.task('favicon-check-update', function (done) {
done();
});
gulp.task('svg-sprite', function () {
gulp.task("svg-sprite", function () {
config = {
svg: {
xmlDeclaration: false,
rootAttributes: {
style: "position: absolute; width: 0; height: 0; overflow: hidden;"
}
style: "position: absolute; width: 0; height: 0; overflow: hidden;",
},
},
mode: {
inline: true,
symbol: {
dest: './',
sprite: 'svg-icon-symbols.html',
dest: "./",
sprite: "svg-icon-symbols.html",
bust: false,
}
}
},
},
};
return gulp.src('src/icons/*.svg')
return gulp
.src("src/icons/*.svg")
.pipe(svgSprite(config))
.pipe(gulp.dest('layouts/partials/'));
.pipe(gulp.dest("layouts/partials/"));
});
gulp.task('iconfont', function () {
var lastUnicode = 0xEA01;
var files = fs.readdirSync('src/iconfont');
gulp.task("iconfont", function () {
var lastUnicode = 0xea01;
var files = fs.readdirSync("src/iconfont");
// Filter files with containing unicode value
// and set last unicode
@ -138,7 +145,7 @@ gulp.task('iconfont', function () {
var currentCode = -1;
if (matches && matches[1]) {
currentCode = parseInt(matches[1].split('u')[1], 16);
currentCode = parseInt(matches[1].split("u")[1], 16);
}
if (currentCode >= lastUnicode) {
@ -146,28 +153,34 @@ gulp.task('iconfont', function () {
}
});
return gulp.src(['src/iconfont/*.svg'])
.pipe(iconfont({
return gulp
.src(["src/iconfont/*.svg"])
.pipe(
iconfont({
startUnicode: lastUnicode,
fontName: 'GeekdocIcons', // required
fontName: "GeekdocIcons", // required
prependUnicode: true, // recommended option
normalize: true,
fontHeight: 1001,
centerHorizontally: true,
formats: ['woff', 'woff2'], // default, 'woff2' and 'svg' are available
formats: ["woff", "woff2"], // default, 'woff2' and 'svg' are available
timestamp: TIMESTAMP, // recommended to get consistent builds when watching files
}))
.pipe(gulp.dest('static/fonts/'));
})
)
.pipe(gulp.dest("static/fonts/"));
});
gulp.task('default', gulp.series(
'sass',
'svg-sprite',
'iconfont',
'favicon-check-update',
'favicon-generate'
));
gulp.task(
"default",
gulp.series(
"sass",
"svg-sprite",
"iconfont",
"favicon-check-update",
"favicon-generate"
)
);
gulp.task('devel', function () {
gulp.watch('src/sass/**/*.*css', gulp.series('sass'));
gulp.task("devel", function () {
gulp.watch("src/sass/**/*.*css", gulp.series("sass"));
});

2
src/favicon/faviconData.json
View File

@ -1 +1 @@
{"result":{"status":"success"},"favicon":{"package_url":"https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/favicon_package_v0.16.zip","files_urls":["https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/android-chrome-192x192.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/android-chrome-512x512.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/apple-touch-icon.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/browserconfig.xml","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/favicon-16x16.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/favicon-32x32.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/favicon.ico","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/mstile-144x144.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/mstile-150x150.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/mstile-310x150.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/mstile-310x310.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/mstile-70x70.png","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/safari-pinned-tab.svg","https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/package_files/site.webmanifest"],"html_code":"<link rel=\"apple-touch-icon\" sizes=\"180x180\" href=\"/apple-touch-icon.png\">\n<link rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/favicon-32x32.png\">\n<link rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/favicon-16x16.png\">\n<link rel=\"manifest\" href=\"/site.webmanifest\">\n<link rel=\"mask-icon\" href=\"/safari-pinned-tab.svg\" color=\"#5bbad5\">\n<meta name=\"msapplication-TileColor\" content=\"#2b5797\">\n<meta name=\"msapplication-TileImage\" content=\"/mstile-144x144.png\">\n<meta name=\"theme-color\" content=\"#ffffff\">","compression":"false","overlapping_markups":["link[rel=\"apple-touch-icon\"]","link[rel=\"shortcut\"]","link[rel=\"shortcut icon\"]","link[rel=\"icon\",sizes=\"16x16\"]","link[rel=\"icon\",sizes=\"32x32\"]","meta[name=\"msapplication-TileColor\"]","meta[name=\"msapplication-TileImage\"]","link[rel=\"manifest\"]","meta[name=\"theme-color\"]","link[rel=\"mask-icon\"]"]},"files_location":{"type":"path","path":"/"},"preview_picture_url":"https://realfavicongenerator.net/files/80e254dbfa2672ac1e4b404bddc9607fdb8612e8/favicon_preview.png","version":"0.16"}
{"result":{"status":"success"},"favicon":{"package_url":"https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/favicon_package_v0.16.zip","files_urls":["https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/android-chrome-192x192.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/android-chrome-512x512.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/apple-touch-icon.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/browserconfig.xml","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/favicon-16x16.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/favicon-32x32.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/favicon.ico","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/mstile-144x144.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/mstile-150x150.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/mstile-310x150.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/mstile-310x310.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/mstile-70x70.png","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/safari-pinned-tab.svg","https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/package_files/site.webmanifest"],"html_code":"<link rel=\"apple-touch-icon\" sizes=\"180x180\" href=\"/apple-touch-icon.png\">\n<link rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/favicon-32x32.png\">\n<link rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/favicon-16x16.png\">\n<link rel=\"manifest\" href=\"/site.webmanifest\">\n<link rel=\"mask-icon\" href=\"/safari-pinned-tab.svg\" color=\"#5bbad5\">\n<meta name=\"msapplication-TileColor\" content=\"#2b5797\">\n<meta name=\"msapplication-TileImage\" content=\"/mstile-144x144.png\">\n<meta name=\"theme-color\" content=\"#ffffff\">","compression":"false","overlapping_markups":["link[rel=\"apple-touch-icon\"]","link[rel=\"shortcut\"]","link[rel=\"shortcut icon\"]","link[rel=\"icon\",sizes=\"16x16\"]","link[rel=\"icon\",sizes=\"32x32\"]","meta[name=\"msapplication-TileColor\"]","meta[name=\"msapplication-TileImage\"]","link[rel=\"manifest\"]","meta[name=\"theme-color\"]","link[rel=\"mask-icon\"]"]},"files_location":{"type":"path","path":"/"},"preview_picture_url":"https://realfavicongenerator.net/files/aa75226dc492eb362022432f442086163ba2f707/favicon_preview.png","version":"0.16"}

4
src/sass/_defaults.scss
View File

@ -27,7 +27,7 @@ $black: rgba(0, 0, 0, 1) !default;
$color-link: rgba(10, 83, 154, 1) !default;
$color-link-visited: rgba(119, 73, 191, 1) !default;
$color-link-footer: rgba(255,163,30,1.0) !default;
$color-link-footer: rgba(255, 163, 30, 1) !default;
$color-code: rgba($gray-200, 0.5) !default;
@ -53,5 +53,5 @@ $sm-breakpoint: $menu-width + $body-min-width + 3rem !default;
$hint-colors: (
info: rgba(102, 187, 255, 1),
warning: rgba(255, 221, 102, 1),
danger: rgba(255, 102, 102, 1)
danger: rgba(255, 102, 102, 1),
) !default;

21
src/sass/_fonts.scss
View File

@ -1,6 +1,7 @@
@font-face {
font-family: "Liberation Sans";
src: url("fonts/LiberationSans-Bold.woff2") format("woff2"), url("fonts/LiberationSans-Bold.woff") format("woff");
src: url("fonts/LiberationSans-Bold.woff2") format("woff2"),
url("fonts/LiberationSans-Bold.woff") format("woff");
font-weight: bold;
font-style: normal;
font-display: swap;
@ -17,7 +18,8 @@
@font-face {
font-family: "Liberation Sans";
src: url("fonts/LiberationSans-Italic.woff2") format("woff2"), url("fonts/LiberationSans-Italic.woff") format("woff");
src: url("fonts/LiberationSans-Italic.woff2") format("woff2"),
url("fonts/LiberationSans-Italic.woff") format("woff");
font-weight: normal;
font-style: italic;
font-display: swap;
@ -25,7 +27,8 @@
@font-face {
font-family: "Liberation Sans";
src: url("fonts/LiberationSans.woff2") format("woff2"), url("fonts/LiberationSans.woff") format("woff");
src: url("fonts/LiberationSans.woff2") format("woff2"),
url("fonts/LiberationSans.woff") format("woff");
font-weight: normal;
font-style: normal;
font-display: swap;
@ -33,7 +36,8 @@
@font-face {
font-family: "Liberation Mono";
src: url("fonts/LiberationMono.woff2") format("woff2"), url("fonts/LiberationMono.woff") format("woff");
src: url("fonts/LiberationMono.woff2") format("woff2"),
url("fonts/LiberationMono.woff") format("woff");
font-weight: normal;
font-style: normal;
font-display: swap;
@ -41,7 +45,8 @@
@font-face {
font-family: "Droid Sans";
src: url("fonts/DroidSans.woff2") format("woff2"), url("fonts/DroidSans.woff") format("woff");
src: url("fonts/DroidSans.woff2") format("woff2"),
url("fonts/DroidSans.woff") format("woff");
font-weight: normal;
font-style: normal;
font-display: swap;
@ -49,7 +54,8 @@
@font-face {
font-family: "Metropolis";
src: url("fonts/Metropolis.woff2") format("woff2"), url("fonts/Metropolis.woff") format("woff");
src: url("fonts/Metropolis.woff2") format("woff2"),
url("fonts/Metropolis.woff") format("woff");
font-weight: normal;
font-style: normal;
font-display: swap;
@ -57,7 +63,8 @@
@font-face {
font-family: "GeekdocIcons";
src: url("fonts/GeekdocIcons.woff2") format("woff2"), url("fonts/GeekdocIcons.woff") format("woff");
src: url("fonts/GeekdocIcons.woff2") format("woff2"),
url("fonts/GeekdocIcons.woff") format("woff");
font-weight: normal;
font-style: normal;
font-display: swap;

1
static/custom.css
View File

@ -1,2 +1 @@
/* You can add custom styles here. */