✨ Added initial documentation

antaresprogramming · Jul 16, 2021 · 0b72d80 · 0b72d80
1 parent d6ad23a
commit 0b72d80
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 21 deletions.
diff --git a/index.js b/index.js
@@ -1,28 +1,44 @@
 const sass = require('sass')
 const Fiber = require('fibers')
 const fs = require('fs')
+const logFormat = require('./scripts/logformat')
 
 const inputFile = './sass/index.scss'
-const outputFile = 'dir/zirconium.css'
-const mapFile = 'dir/zirconium.css.map'
-const minOutputFile = 'dir/zirconium.min.css'
-const minMapFile = 'dir/zirconium.min.css.map'
-const includesDirectories = ["sass/", "sass/components"]
+const outputFile = 'dist/zirconium.css'
+const mapFile = 'dist/zirconium.css.map'
+const minOutputFile = 'dist/zirconium.min.css'
+const minMapFile = 'dist/zirconium.min.css.map'
+const includesDirectories = ['sass/', 'sass/components']
 
-console.log("Rendering zirconium.css...")
+const publicOutfile = 'public/src/zirconium.min.css'
+const publicMapfile = 'public/src/zirconium.min.css.map'
+
+console.log('Rendering zirconium.css...')
 sass.render(
 	{
 		file: inputFile,
-        sourceMap: true,
-        outFile: outputFile,
-        includePaths: includesDirectories
+		sourceMap: true,
+		outFile: outputFile,
+		includePaths: includesDirectories,
 	},
 	(err, result) => {
-		const css = result.css.toString('utf-8')
-		const map = result.map.toString('utf-8')
-		fs.writeFileSync(outputFile, css)
-		fs.writeFileSync(mapFile, map)
-		console.log('zirconium.css: Done.')
+		if (!err) {
+			const css = result.css.toString('utf-8')
+			const map = result.map.toString('utf-8')
+			fs.writeFileSync(outputFile, css)
+			console.log(
+				logFormat.successHeader('Done:'),
+				logFormat.successBody(outputFile)
+			)
+
+			fs.writeFileSync(mapFile, map)
+			console.log(
+				logFormat.successHeader('Done:'),
+				logFormat.successBody(mapFile)
+			)
+		} else {
+			console.log(logFormat.errorBody(err.formatted), '\n\n')
+		}
 	}
 )
 
@@ -31,15 +47,44 @@ sass.render(
 	{
 		file: inputFile,
 		sourceMap: true,
-		outFile: outputFile,
+		outFile: minOutputFile,
 		includePaths: includesDirectories,
-        outputStyle: "compressed"
+		outputStyle: 'compressed',
 	},
 	(err, result) => {
-		const css = result.css.toString('utf-8')
-		const map = result.map.toString('utf-8')
-		fs.writeFileSync(minOutputFile, css)
-		fs.writeFileSync(minMapFile, map)
-		console.log('zirconium.min.css: Done.')
+		if (!err) {
+			const css = result.css.toString('utf-8')
+			const map = result.map.toString('utf-8')
+			fs.writeFileSync(minOutputFile, css)
+			console.log(
+				logFormat.successHeader('Done:'),
+				logFormat.successBody(minOutputFile)
+			)
+
+			fs.writeFileSync(minMapFile, map)
+			console.log(
+				logFormat.successHeader('Done:'),
+				logFormat.successBody(minMapFile)
+			)
+
+			copyToPublic()
+		} else {
+			console.log(logFormat.errorBody(err.formatted), '\n\n')
+		}
 	}
 )
+
+function copyToPublic() {
+	console.log('Updating /public/ copies...')
+	fs.copyFileSync(minOutputFile, publicOutfile)
+	console.log(
+		logFormat.successHeader('Done:'),
+		logFormat.successBody(publicOutfile)
+	)
+
+	fs.copyFileSync(minMapFile, publicMapfile)
+	console.log(
+		logFormat.successHeader('Done:'),
+		logFormat.successBody(publicMapfile)
+	)
+}
diff --git a/public/index.html b/public/index.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta http-equiv="X-UA-Compatible" content="IE=edge" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>
+			Zirconium &middot; An opinionated CSS library for Antares Programming
+		</title>
+		<link rel="stylesheet" href="src/zirconium.min.css">
+	</head>
+	<body>
+		<h1>Zirconium</h1>
+
+		<p>
+			An opinionated CSS library of components. Offical CSS written by [Francis
+			Rubio](https://github.com/maniczirconium/maniczirconium) for [Antares
+			Programming](https://antaresprogramming.github.io/)
+		</p>
+
+		<h2>Goals</h2>
+		<ul>
+			<li>
+				Standardize components for the website - Support dark mode from the
+				get-go
+			</li>
+			<li>
+				Promote accessibility by using HTML structure as basis for styling in
+				some components
+			</li>
+			<li>Include minimal JavaScript (this is for a blog, not a website)</li>
+		</ul>
+	</body>
+</html>
diff --git a/public/src/zirconium.min.css b/public/src/zirconium.min.css