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.

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

List popular sites that use Just the Docs #1300

Open
mattxwang opened this issue Jul 26, 2023 · 7 comments
Open

List popular sites that use Just the Docs #1300

mattxwang opened this issue Jul 26, 2023 · 7 comments
Labels
enhancement status: wip Issues being worked on by someone.

Comments

@mattxwang
Copy link
Member

Ref: #1244 (comment)

It would be good to have a page somewhere with links to major sites that use JtD. Apart from providing profiling examples, it might also attract new users.

This is relatively common among open-source projects and could also foster some goodwill (especially with our sponsors). I also anticipate that there are many, many sites that use JtD that we're not aware of (ex, just the class + various google open-source projects come to mind).

@hamoid
Copy link

hamoid commented Jul 27, 2023

Should people reply with URLs to their docs? Or do you have a way to find out where it is used?

@pdmosses
Copy link
Contributor

For creating our proposed showcase page, we need only the URL of the published website.

However, when the repo used to build the site is public, please include also the URL of the repo itself, so the showcase page can link also to the repo. Our users may find it helpful to browse the repos of major websites, especially regarding theme configuration and customization.

The repo URL also allows the maintainers to clone the repo locally, and profile building the website with different versions of Jekyll and Just the Docs. The efficiency of building websites with hundreds of pages has been improved (see the current profiling results) and profiling can be a useful regression test for future PRs.

@hamoid
Copy link

hamoid commented Jul 27, 2023

Our system is probably rather unconventional and not sure if popular enough, but I'll leave here the links anyway:

https://guide.openrndr.org/

Source
https://github.com/openrndr/openrndr-guide

It is unconventional because the guide is generated from Kotlin code. That code includes texts plus embedded programs that produce images and video files that are included in the guide. Try clicking on [edit on GitHub] on the home page to see the code that created the video file.

The system does several things: converts Kotlin into markdown, extracts programs and pushes them to a separate repo which people can clone to run the programs locally, it runs the programs to produce images and video files, pushes everything to the generated branch, then GitHub uses Jekyll to render the content to HTML and serves it to visitors.

@max06
Copy link
Contributor

max06 commented Jul 27, 2023

Sure, let's go!

Live at https://docs.gec.io - made for customers

Source at https://github.com/gecio/gecio.github.io

Showcases the use of collections, and jekyll-polyglot

@pdmosses
Copy link
Contributor

@max06 Thanks for the links!

I think it'd be helpful if the footer of the home page refers to being built using Just the Docs. The current "Hosted with love on GitHub" suggests to me that GitHub itself has provided the theme… Moreover, Googling for sites "using Just the Docs" seems unlikely to find yours!

@max06
Copy link
Contributor

max06 commented Jul 27, 2023

Sure, but I don't think I can convince my employer to allow me putting that on the page 😆

@mattxwang mattxwang added the status: wip Issues being worked on by someone. label Sep 18, 2023
@diegobollini
Copy link

It's not popular but it's mine (and in spanish) 🙏
https://wiki.bolli.ar/
https://github.com/diegobollini/miwiki

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement status: wip Issues being worked on by someone.
Projects
None yet
Development

No branches or pull requests

5 participants