Skip to content

Documentation upgrade for release v0.9.0 #14

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

Draft
almereyda wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Documentation upgrade for release v0.9.0 #14

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e1e57b9
upgrade: marked
almereyda Feb 20, 2022
941cffa
default to docs output directory
almereyda Feb 20, 2022
cedc3a3
switch favicon to existing svg logo
almereyda Feb 20, 2022
7dee18c
add screenshot source for SSG build copy
almereyda Feb 20, 2022
500e1f4
v0.2.0
almereyda Feb 20, 2022
579c371
add PNG logo icon
almereyda Feb 21, 2022
a5d954d
add license from package.json to README
almereyda Feb 21, 2022
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
55 changes: 47 additions & 8 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "boringproxy.io",
"version": "0.1.0",
"version": "0.2.0",
"description": "",
"main": "ssg.js",
"directories": {
Expand All @@ -17,6 +17,6 @@
"devDependencies": {
"highlight.js": "^10.3.2",
"highlightjs": "^9.16.2",
"marked": "^1.2.2"
"marked": "^4.0.12"
}
}
4 changes: 2 additions & 2 deletions partials/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>boringproxy.io</title>
<link rel="stylesheet" type="text/css" href="/styles.css">
<link rel="icon" href="/logo.png">
<link rel="icon" href="/logo.svg">
Copy link
Copy Markdown
Member

@anderspitman anderspitman Feb 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would love to switch to using the SVG (especially for the logo baked into the boringproxy executable), but AFAIK safari still doesn't support SVG favicons.

Copy link
Copy Markdown
Contributor Author

@almereyda almereyda Feb 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I will download the current PNG from the website and add it to the repository. I was simply falling back to the one file available to me.

Copy link
Copy Markdown
Member

@anderspitman anderspitman Feb 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you wouldn't mind using this logo (recently added to boringproxy repo) that would be ideal:

https://github.com/boringproxy/boringproxy/blob/master/default_logo.png

Copy link
Copy Markdown
Member

@anderspitman anderspitman Feb 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can rename it to logo.png for boringproxy.io

</head>

<body>
<div class='content'>
<header>
Expand Down
Binary file added screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions ssg.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const fs = require('fs');
const path = require('path');
const marked = require('marked');
const { marked } = require('marked');
const hljs = require('highlightjs');

marked.setOptions({
Expand All @@ -13,7 +13,7 @@ marked.setOptions({
});

const inDir = './';
const outDir = (process.argv.length !== 3) ? './' : `./${process.argv[2]}/`;
const outDir = (process.argv.length !== 3) ? 'docs' : `./${process.argv[2]}/`;
fs.mkdirSync(outDir, { recursive: true });

const partialsDir = path.join(inDir, 'partials');
Expand All @@ -32,7 +32,7 @@ for (const pageMd of pagesFiles) {
}

const mdText = fs.readFileSync(path.join(pagesDir, pageMd.name), 'utf-8');
const htmlText = headerHtml + marked(mdText) + footerHtml;
const htmlText = headerHtml + marked.parse(mdText) + footerHtml;
const pageName = path.parse(pageMd.name).name;

let htmlDir;
Expand Down