javascript
javascript copied to clipboard
Suggestion to set up Github Page
Maybe you want to set up a GitHub Page and get the custom domain styleguide.js.org for free.
(renaming the repo to styleguide
would be required)
cc @hshoff
I think renaming the project at this point (with 16k stars and 3k forks) is a bad decision.
This can be done by a custom CNAME in the gh-pages
This falls in line with https://github.com/airbnb/javascript/issues/263
Definitely need to give this some more thought, but here are my initial thoughts.
- I'm hesitant about rebranding/renaming because personally I don't agree with there being
The one true way to write JavaScript
. That was never the intention of this project. I fall in the consistency is important for projects and teams camp. (See Why does JavaScript need a style guide? #102 for more on the importance of consistency.) - I'd prefer more projects had style guides than more projects follow this style guide.
- Maybe folks are just troubled by the name? They want a better way to refer to the style guide they use? Python has PEP 8 and Go has fmt.
- When we released this 3 years ago our goal was to provide a template or map for other teams. Here's the original announcement found in the wiki...perhaps the goal has naturally changed over time as we've added more resources, explanations and responded to community feedback.
- 3 years later and most of the improvements to the guide have largely been community driven. Currently at 92 contributors (thank you! :trophy:). We'll likely hit 100 once we get around to reviewing all the currently open PRs (sorry for the delay folks). I've always been fascinated by the number of contributors and forks, because it shows the power of open source, how a community can drive and evolve a project over time.
It's not clear to me what the best way forward is just yet, but open to feedback and would love to hear more thoughts on this.
I've stumbled upon https://github.com/codeguy/php-the-right-way and http://www.phptherightway.com/ and how they manage the content and especially the 'Translations' section. I can get back when I test this approach on one of my projects that has a huge README, Jekyll is still a mystery to me.
You should take a look at gitbook.com, which is a web platform based on the open source gitbook.
Then you would be able to generate a beautiful web book (and e-books) updated every time you commit to this repo.
Here is for example a simple book about Javascript: http://gitbookio.gitbooks.io/javascript/content/en/index.html which is also hosted on GitHub: https://github.com/GitbookIO/javascript
There are a few more examples of exposing a static build site using GitHub Actions and GitHub Pages.
We have the following options for this:
- Just using the default build behaviour of Github Pages (triggering a Jekyll build). an example I did with this project https://github.com/flutterarsenal/FlutterArsenal/
- Using Github Actions to run custom build and publish to gh-pages branch for Github Pages. Link to nice dev.to post
Any update ?