Skip to content
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

refactor: improve wiki css #281

Merged
merged 1 commit into from
Nov 30, 2023
Merged

refactor: improve wiki css #281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions esbuild.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
const kPublicDir = path.join(__dirname, "public");
const kOutDir = path.join(__dirname, "dist");
const kImagesDir = path.join(kPublicDir, "img");
const kNodeModulesDir = path.join(__dirname, "node_modules");

await esbuild.build({
entryPoints: [
path.join(kPublicDir, "js", "master.js"),
path.join(kPublicDir, "css", "style.css"),
path.join(kNodeModulesDir, "highlight.js", "styles", "github.css"),
...getBuildConfiguration().entryPoints
],
loader: {
Expand Down
1 change: 0 additions & 1 deletion public/css/reset.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ video {
border: 0;
font-size: 100%;
font: inherit;
vertical-align: baseline;
}

/* HTML5 display-role reset for older browsers */
Expand Down
1 change: 1 addition & 0 deletions views/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

<link rel="stylesheet" href="public/css/style.css" />
<link rel="stylesheet" href="workspaces/documentation-ui/src/css/main.css" />
<link rel="stylesheet" href="node_modules/highlight.js/styles/github.css" />
<script src="public/js/master.js" defer></script>
<title>Node-Secure</title>

Expand Down
5 changes: 4 additions & 1 deletion workspaces/documentation-ui/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@ const kSASTWarnings = [
"unsafe-import",
"unsafe-regex",
"unsafe-stmt",
"shady-link",
"encoded-literal",
"short-identifiers",
"suspicious-literal",
"suspicious-file",
"obfuscated-code",
"weak-crypto"
].map((name) => ({ name }));
Expand Down Expand Up @@ -80,7 +82,8 @@ export function render(rootElement, options = {}) {

const header = new Header(kHeaderMenus, { defaultName: "flags" });
const mainContainer = utils.createDOMElement("div", {
className: "documentation--main", childs: [header.dom, ...containers]
className: "documentation--main",
childs: [header.dom, ...containers]
});

for (const node of rootElement.childNodes) {
Expand Down
1 change: 1 addition & 0 deletions workspaces/documentation-ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"license": "MIT",
"dependencies": {
"@nodesecure/flags": "^2.4.0",
"highlight.js": "^11.9.0",
"markdown-it": "^13.0.1"
}
}
10 changes: 4 additions & 6 deletions workspaces/documentation-ui/src/components/header.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,10 @@ export class Header {

const ul = utils.createDOMElement("ul", {
childs: [
...menu.map((item) => {
return utils.createDOMElement("li", {
text: item.name,
attributes: { "data-menu": item.title }
});
})
...menu.map((item) => utils.createDOMElement("li", {
text: item.name,
attributes: { "data-menu": item.title }
}))
]
});

Expand Down
103 changes: 83 additions & 20 deletions workspaces/documentation-ui/src/css/content.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
max-width: 100%;
}

.documentation--content span {
.documentation--content div>span {
background: #b8e9ff;
padding: 2px;
border-radius: 2px;
Expand Down Expand Up @@ -45,15 +45,46 @@
height: 26px;
font-size: 22px;
border-bottom: 1px solid #3722AF;
margin-top: 2.5rem;
margin-top: 2rem;
margin-bottom: 1rem;
font-weight: bold;
}

.documentation--content ul+h2 {
margin-top: 1rem !important;
}

.documentation--content h3 {
height: 26px;
font-size: 18px;
margin-top: 1rem;
margin-bottom: 0.5rem;
border-bottom: 1px solid #d4d4d4;
font-weight: bold;
}

.documentation--content kbd {
background: linear-gradient(to bottom, rgba(238,238,238,1) 0%,rgba(229,229,229,1) 100%);
padding: 1px 5px;
border-radius: 4px;
border: 2px solid #cdcdcd;
}

.documentation--content p {
text-align: justify;
line-height: 1.20;
line-height: 1.50;
color: #314249;
margin-right: 10px;
}

.documentation--content p>code {
background: #feffd5;
padding: 1px 5px;
border-radius: 4px;
}

.documentation--content p+p {
margin-top: 10px;
}

.documentation--content p.note {
Expand All @@ -65,37 +96,61 @@
border-radius: 2px;
box-sizing: border-box;
}
.documentation--content p.note > span {

.documentation--content blockquote {
background: #81d4fa59;
color: #283593 !important;
border-left: 5px solid #01579B;
margin: 0.5em 10px;
padding: 0.5em 10px;
}

.documentation--content blockquote p {
display: inline;
}

.documentation--content blockquote strong,
.documentation--content blockquote code {
font-weight: bold;
}

.documentation--content p.note>span {
background: #FFF9C4;
}

.documentation--content ul {
margin: 1rem 0;
list-style: disc !important;
border-radius: 4px;
box-shadow: 1px 1px 10px rgb(20 20 20 / 10%);
margin: 0.5rem 0;
box-shadow: 1px 1px 10px rgba(20, 20, 20, 0.205);
margin-right: 10px;
}

.documentation--content ul li {
min-height: 36px;
display: flex;
align-items: center;
padding: 2px 10px;
padding: 7px 10px;
border-radius: 4px;
background: #FFF;
}

.documentation--content ul li:nth-child(odd) {
background: #ECEFF1;
.documentation--content ul li+li {
margin-top: 3px;
}

.documentation--content ul li:nth-child(even) {
background: #CFD8DC;
.documentation--content ul li:before {
content: "• ";
}

.documentation--content ul li a {
color: #1976D2;
}

.documentation--content ul li strong,
.documentation--content ul li code {
font-weight: bold;
}

table {
width: 100%;
border-spacing: 2px;
table-layout:fixed;
table-layout: fixed;
}

table thead tr th {
Expand Down Expand Up @@ -135,16 +190,24 @@ pre {
word-wrap: break-word;
overflow: auto;
border-radius: 4px;
flex-shrink: 0;
margin-top: 10px !important;
margin-right: 10px !important;
}

pre+p {
margin-top: 10px;
}

pre code.hljs {
font-size: 16px;
}

pre code {
font-family: "Inconsolata", "Monaco", "Consolas", "Andale Mono", "Bitstream Vera Sans Mono", "Courier New", Courier, monospace;
display: block;
margin: 0 0 0 60px;
padding: 15px 16px 14px;
border-left: 1px solid #37474F;
overflow-x: auto;
font-size: 13px;
line-height: 19px;
color: #ddd;
}
20 changes: 18 additions & 2 deletions workspaces/documentation-ui/src/fetch.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,19 @@ import * as CONSTANTS from "./constants.js";

// Import Third-party Dependencies
import MarkdownIt from "markdown-it";
import hljs from "highlight.js/lib/core";
import javascript from "highlight.js/lib/languages/javascript";
import json from "highlight.js/lib/languages/json";

hljs.registerLanguage("javascript", javascript);
hljs.registerLanguage("json", json);

// CONSTANTS
const kRawGithubFlagsURL = "https://raw.githubusercontent.com/NodeSecure/flags/main/src/flags";
const kRawGithubWarningsURL = "https://raw.githubusercontent.com/NodeSecure/js-x-ray/master/docs";
const kMarkdownConvertor = new MarkdownIt();
const kMarkdownConvertor = new MarkdownIt({
html: true
});

/** @type {Map<string, string>} */
export const cache = new Map();
Expand Down Expand Up @@ -55,7 +63,14 @@ export async function fetchNodeSecureWarningsByTitle(title, options = {}) {

const httpResponse = await fetch(`${kRawGithubWarningsURL}/${title}.md`);
const markdownResponse = await httpResponse.text();
const htmlResponse = kMarkdownConvertor.render(markdownResponse);
const htmlResponse = kMarkdownConvertor.render(
markdownResponse
.replaceAll("[!IMPORTANT]", "🚨")
.replaceAll("[!NOTE]", "📝")
.replaceAll("[!CAUTION]", "🔶")
.replaceAll("[!WARNING]", "⚠️")
.replaceAll("[!TIP]", "💡")
);

if (cacheReponse) {
cache.set(cacheTitle, htmlResponse);
Expand All @@ -78,4 +93,5 @@ export async function fetchAndRenderByMenu(menuElement, kind = "flags") {

const documentContentElement = document.querySelector(`.documentation--${kind} .${CONSTANTS.DIV_CONTENT}`);
documentContentElement.innerHTML = kind === "flags" ? htmlResponse : `<div>${htmlResponse}</div>`;
hljs.highlightAll();
}
Loading