search

js-org / js.org

Dedicated to JavaScript and its awesome community since 2015
https://JS.ORG
5.25k stars 3.48k forks source link

kun.js.org #9201

Closed lmk97 closed 2 months ago

lmk97 commented 2 months ago
lmk97 commented 2 months ago

👋 Could I ask why you're hosting the site for this library under your personal GitHub Pages repository, rather than in a repository specific to the library itself (e.g. https://github.com/lmk97/kun)?

I've recently been writing a JavaScript runtime and the documentation is based on markdown. I used the ssg tool to generate a static web site, but didn't want to put the site's html, css, js, etc. files in the source directory, so that's why I separated them out.

lmk97 commented 2 months ago

👋 Could I ask why you're hosting the site for this library under your personal GitHub Pages repository, rather than in a repository specific to the library itself (e.g. https://github.com/lmk97/kun)?

The reason the repository you just looked at is empty is because I'm currently the only developer, so I didn't submit the code before. Now that I've submitted the code, I can prove what I'm saying is true.

MattIPv4 commented 2 months ago

Your answer doesn't really answer what I asked. I understanding you're writing the docs in Markdown and then SSG'ing them, that is pretty normal. Most folks would use a gh-pages branch within the project's repo to host the GitHub Pages site for the SSG'ed docs, or use the more modern GitHub Actions workflow to SSG the docs and upload them directly to GitHub Pages without needing a second branch. Having it in your personal GitHub Pages repository seems a bit odd.

lmk97 commented 2 months ago

Your answer doesn't really answer what I asked. I understanding you're writing the docs in Markdown and then SSG'ing them, that is pretty normal. Most folks would use a gh-pages branch within the project's repo to host the GitHub Pages site for the SSG'ed docs, or use the more modern GitHub Actions workflow to SSG the docs and upload them directly to GitHub Pages without needing a second branch. Having it in your personal GitHub Pages repository seems a bit odd.

Sorry, I just realized that there are two ways to do a github page, user pages and project pages. project pages is indeed the better way. I've made the changes, please take a look again when you have time.

indus commented 2 months ago

Welcome https://kun.js.org