New site! 🚀 (#1275)

* add new docs

* Add styling

* Move files

* Add active selection

* improve grid overview

* improve grid

* Add icon detail page

* Minor changes

* Fix icon preview

* optimize home card

* Add code examples

* Add gitignore

* correct temp directory

* Add first cusotmizer

* Add customizer

* fix images paths

* Add reset function

* Adjust category rendering

* Add packages section

* Some fixes

* Fix vercel build icon

* Small code adjustment

* move file

* Try this

* Add code groups with syntax highlighting

* Add search icon

* Cleanup

* update lockfile

* turnoff 404

* remove docs/iconMetaData.ts

* fix build

* Fix build 2

* cleanup

* Add icon customizer

* Fix build

* Add steps

* Add Button menu

* A lot off fixes!

* cleanup

* Fix build

* Css fixes

* Override menu icon

* try this to improve preformance

* minor improvements

* add comment

* add readme

* Add title

* minor fixes

* Fixes sliders + removes random backticks from index

* Added package list base, still WIP

* Added Guide+Source buttons to package list items

* Responsive support for XS screens

* Map categories count

* Adjust tooltip hover position

* Add see in action icon

* Add download options

* Aligns category list items to baseline and decreases category count weight

* Fixes event target error for categorylistitems

* Added icon release metadata builder

* Adds version badges to hero + icon detail overlay

* Added contributors.
Added Copy Angular.
Added release info to icon page.

* Centres contributor tooltip

* Fixed stroke step + added reset button

* Extracted reset button as a separate component for reusability

* Makes HomeIconCustomizerIcons less dense

* Fixes Button menu

* adjust versions and contributors styling on detail page

* Fix build?

* Fix build 2?

* Fix build 3

* Fix build 4

* Fix build 5?

* Add latest gh-icon changes

* Add comment

* Try fetch tags to retrieve release data

* try fetch all tags

* Add related icons

* Add stikcy search bar

* Add no results components

* Try to fix animation

* Try optimizing for categories

* Hide buggy animated icon

* minor fixes

* Add footer

* Add contributute link in footer

* Add copy name

* Add 100% preview icons

* remove site directory

* clean up

* Add redirects

* Fix build?

* fix redirect?

* minor improvements

* Fix icons preview on mobile

* Small preformance improvement

* Dark mode fixes for package icons

* Sort related icons by similarity + somewhat better name similarity matching

* Replace icon design guide images with uniform SVGs

* update lockfile

* Adds git clone to manually fetch the main repository for creating release metadata

* Remove initial v0.0.0 from release metadata

* Add extra CTA to no results behaviour

* Remove tags, as they are too overused

* Revert "Remove tags, as they are too overused"

This reverts commit 909b7563c0.

* Checkout icons from main

* Add absoluteStrokeWidth switch

* Add absolute strokewidth to home customizer

* Add absolute strokewidth to copy code button

* remove unused import

* compare build time

* improve build speed

* Try new release meta data script

* add fetch tags

* try with branch and remote

* try with url

* try without ssh

* Fix fetch tags in build file

* Cleanup

* Fix fallback

* improve release data

* delete relatedIcons.json, because it should be gitignored

* Add icon details

* Fix import

* minor fixes

* Try running script parallel

* Revert icon details

* include aliases in  release meta data

* Final fixes

* Final fixes 2

* minor code adjustment

* Fix build

* test

* Revert concurrent build flow

* switch back to concurrent build strategy

* revert icon changes

* update package.json

* update package.json

* dedube packages

---------

Co-authored-by: Karsa <karsa@karsa.org>
This commit is contained in:
Eric Fennis
2023-06-04 16:59:38 +02:00
committed by GitHub
co-authored by Karsa
parent 2ebf99f591
commit 5bfc736b61
277 changed files with 9850 additions and 11579 deletions
+44
View File
@@ -0,0 +1,44 @@
import fs from 'fs';
import path from 'path';
import { readSvgDirectory, toCamelCase } from './helpers.mjs';
const currentDir = process.cwd();
const ICONS_DIR = path.resolve(currentDir, '../icons');
const iconJsonFiles = readSvgDirectory(ICONS_DIR, '.json');
const location = path.resolve(currentDir, '.vitepress/data', 'iconMetaData.ts');
if (fs.existsSync(location)) {
fs.unlinkSync(location);
}
const iconMetaIndexFileImports = [];
const iconMetaIndexFileExports = [];
iconJsonFiles.forEach((iconJsonFile) => {
const iconName = path.basename(iconJsonFile, '.json');
iconMetaIndexFileImports.push(
`import ${toCamelCase(iconName)}Metadata from '../../../icons/${iconName}.json';`,
);
iconMetaIndexFileExports.push(` '${iconName}': ${toCamelCase(iconName)}Metadata,`);
});
try {
await fs.promises.writeFile(
location,
`\
${iconMetaIndexFileImports.join('\n')}
export default {
${iconMetaIndexFileExports.join('\n')}
}
`,
'utf-8',
);
console.log('Successfully write icon json file index');
} catch (error) {
throw new Error(`Something went wrong generating icon json file index file,\n ${error}`);
}
+60
View File
@@ -0,0 +1,60 @@
import fs from 'fs';
import path from 'path';
import renderIconsObject from './render/renderIconsObject.mjs';
import { readSvgDirectory, toCamelCase } from './helpers.mjs';
const currentDir = process.cwd();
const ICONS_DIR = path.resolve(currentDir, '../icons');
const svgFiles = readSvgDirectory(ICONS_DIR);
const icons = renderIconsObject(svgFiles, ICONS_DIR, true);
const iconNodesDirectory = path.resolve(currentDir, '.vitepress/data', 'iconNodes');
if (fs.existsSync(iconNodesDirectory)) {
fs.rmSync(iconNodesDirectory, { recursive: true, force: true });
}
if (!fs.existsSync(iconNodesDirectory)) {
fs.mkdirSync(iconNodesDirectory);
}
const iconIndexFile = path.resolve(iconNodesDirectory, `index.ts`);
const iconIndexFileImports = [];
const iconIndexFileExports = [];
const iconIndexFileDefaultExports = [];
const writeIconFiles = Object.entries(icons).map(async ([iconName, { children }]) => {
// We need to use .node.json because the there is a file called package, which is a reserved word for packages.
const location = path.resolve(iconNodesDirectory, `${iconName}.node.json`);
const iconNode = children.map(({ name, attributes }) => [name, attributes]);
const output = JSON.stringify(iconNode, null, 2);
await fs.promises.writeFile(location, output, 'utf-8');
iconIndexFileImports.push(`import ${toCamelCase(iconName)}Node from './${iconName}.node.json';`);
iconIndexFileExports.push(` ${toCamelCase(iconName)}Node as ${toCamelCase(iconName)},`);
iconIndexFileDefaultExports.push(` '${iconName}': ${toCamelCase(iconName)}Node,`);
});
try {
await Promise.all(writeIconFiles);
await fs.promises.writeFile(
iconIndexFile,
`\
${iconIndexFileImports.join('\n')}
export {
${iconIndexFileExports.join('\n')}
}
export default {
${iconIndexFileDefaultExports.join('\n')}
}
`,
'utf-8',
);
console.log('Successfully write', writeIconFiles.length, 'iconNodes.');
} catch (error) {
throw new Error(`Something went wrong generating iconNode files,\n ${error}`);
}
+78
View File
@@ -0,0 +1,78 @@
import fs from 'fs';
import path from 'path';
import { readSvgDirectory } from './helpers.mjs';
const currentDir = process.cwd();
const ICONS_DIR = path.resolve(currentDir, '../icons');
const svgFiles = readSvgDirectory(ICONS_DIR, '.json');
const location = path.resolve(currentDir, '.vitepress/data', 'relatedIcons.json');
if (fs.existsSync(location)) {
fs.unlinkSync(location);
}
const nameWeight = 5;
const tagWeight = 4;
const categoryWeight = 3;
const arrayMatches = (a, b) => {
// let matches = 0;
// for (let i = 0; i < a.length; ++i) {
// if (b.indexOf(a[i]) != -1) {
// matches++;
// }
// }
// return matches;
return a.filter(item => b.includes(item)).length;
}
const nameParts = (icon) => [icon.name, ...icon.aliases ?? []]
.join('-')
.split('-')
.filter(word => word.length > 2)
const getRelatedIcons = (currentIcon, icons) => {
const iconSimilarity = (item) =>
nameWeight * arrayMatches(nameParts(item), nameParts(currentIcon))
+ categoryWeight * arrayMatches(item.categories, currentIcon.categories)
+ tagWeight * arrayMatches(item.tags, currentIcon.tags)
;
return icons
.filter(i => i.name !== currentIcon.name)
.map(icon => ({icon, similarity: iconSimilarity(icon)}))
.filter(a => a.similarity > 0) // @todo: maybe require a minimal non-zero similarity
.sort((a, b) => b.similarity - a.similarity)
.map(i => i.icon)
;
}
const iconsMetaDataPromises = svgFiles.map(async (iconName) => {
// eslint-disable-next-line import/no-dynamic-require, global-require
const metaData = await import(`../icons/${iconName}`, {
assert: { type: 'json' }
});
const name = iconName.replace('.json', '');
return {
name,
...metaData.default
};
});
const iconsMetaData = await Promise.all(iconsMetaDataPromises);
const relatedIcons = iconsMetaData.map(icon => {
const iconRelatedIcons = getRelatedIcons(icon, iconsMetaData);
return [icon.name, iconRelatedIcons.map(i => i.name)];
});
fs.promises
.writeFile(location, JSON.stringify(Object.fromEntries(relatedIcons), null, 2), 'utf-8')
.then(() => {
console.log('Successfully written relatedIcons.json file');
})
.catch((error) => {
throw new Error(`Something went wrong generating iconNode files,\n ${error}`);
});
+168
View File
@@ -0,0 +1,168 @@
/* eslint-disable no-restricted-syntax, no-await-in-loop */
import { simpleGit } from 'simple-git';
import semver from 'semver';
import fs from 'fs';
import path from 'path';
import { readSvgDirectory } from './helpers.mjs';
const DATE_OF_FORK = '2020-06-08T16:39:52+0100';
const git = simpleGit();
const currentDir = process.cwd();
const ICONS_DIR = path.resolve(currentDir, '../icons');
const iconJsonFiles = readSvgDirectory(ICONS_DIR, '.json');
const location = path.resolve(currentDir, '.vitepress/data', 'releaseMetaData.json');
if (fs.existsSync(location)) {
fs.unlinkSync(location);
}
const fetchAllReleases = async () => {
await git.fetch('https://github.com/lucide-icons/lucide.git', '--tags');
return Promise.all(
(await git.tag(['-l']))
.trim()
.split(/\n/)
.filter((tag) => semver.valid(tag))
.sort(semver.compare),
);
};
const tags = await fetchAllReleases();
const comparisonsPromises = tags.map(async (tag, index) => {
const previousTag = tags[index - 1];
if (!previousTag) return undefined;
const diff = await git.diff(['--name-status', '--oneline', previousTag, tag]);
const files = diff.split('\n').map((line) => {
const [status, file, renamedFile] = line.split('\t');
return { status, file, renamedFile };
});
const iconFiles = files.filter(({ file }) => file != null && file.startsWith('icons/'));
let date = (await git.show(['-s', '--format=%cI', tag])).trim();
// Fallback to dat of fork if date is not valid
if (!date.startsWith('20')) {
date = DATE_OF_FORK;
}
return {
tag,
date,
iconFiles,
};
});
const comparisons = await Promise.all(comparisonsPromises);
const newReleaseMetaData = {};
comparisons.forEach(({ tag, iconFiles, date } = {}) => {
if (tag == null) return;
iconFiles.forEach(({ status, file, renamedFile }) => {
if (file.endsWith('.json')) return;
const version = tag.replace('v', '');
const iconName = path.basename(file, '.svg');
if (newReleaseMetaData[iconName] == null) newReleaseMetaData[iconName] = {};
const releaseData = {
version,
date,
};
if (status.startsWith('R')) {
// Make sure set the old one as well
newReleaseMetaData[iconName].changedRelease = {
version,
date,
};
const renamedIconName = path.basename(renamedFile, '.svg');
if (newReleaseMetaData[renamedIconName] == null) {
newReleaseMetaData[renamedIconName] = {};
}
newReleaseMetaData[renamedIconName].changedRelease = {
version,
date,
};
}
if (status === 'A') {
if ('changedRelease' in newReleaseMetaData[iconName]) {
throw new Error(`Icon '${iconName}' has already changedRelease set.`);
}
newReleaseMetaData[iconName].createdRelease = releaseData;
newReleaseMetaData[iconName].changedRelease = releaseData;
}
if (status === 'M') {
newReleaseMetaData[iconName].changedRelease = {
version,
date,
};
}
});
});
const defaultReleaseMetaData = {
createdRelease: {
version: '0.0.0',
date: DATE_OF_FORK,
},
changedRelease: {
version: '0.0.0',
date: DATE_OF_FORK,
},
};
try {
const releaseMetaData = await Promise.all(
iconJsonFiles.map(async (iconJsonFile) => {
const iconName = path.basename(iconJsonFile, '.json');
if (iconName in newReleaseMetaData === false) {
console.error(`Could not find release metadata for icon '${iconName}'.`);
}
const contents = {
...defaultReleaseMetaData,
...(newReleaseMetaData[iconName] ?? {}),
};
const metaData = await fs.promises.readFile(path.join(ICONS_DIR, iconJsonFile), 'utf-8');
const iconMetaData = JSON.parse(metaData);
const aliases = iconMetaData.aliases ?? [];
if (aliases.length) {
aliases.forEach((alias) => {
if (alias in newReleaseMetaData === false) {
return;
}
contents.createdRelease = newReleaseMetaData[alias].createdRelease;
});
}
return [iconName, contents];
}),
);
await fs.promises.writeFile(
location,
JSON.stringify(Object.fromEntries(releaseMetaData), null, 2),
'utf-8',
);
console.log('Successfully written icon release meta files');
} catch (error) {
throw new Error(`Something went wrong generating icon release meta cache file,\n ${error}`);
}
+35
View File
@@ -0,0 +1,35 @@
import path from 'path';
import fs from 'fs';
const currentDir = process.cwd();
const vercelRouteConfig = {
version: 3,
overrides: {},
cleanUrls: true,
routes: [
{
handle: 'filesystem',
},
{
src: '(?<url>/api/.*)',
dest: '/__nitro?url=$url',
},
// {
// source: '/icon/:path*',
// destination: '/icons/:path*',
// permanent: true,
// },
// {
// src: '/(.*)',
// status: 404,
// dest: '/static/404.html',
// },
],
};
const output = JSON.stringify(vercelRouteConfig, null, 2);
const vercelOutputJosn = path.resolve(currentDir, '.vercel/output/config.json');
fs.writeFileSync(vercelOutputJosn, output, 'utf-8');