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

Create github-pages jekyll/bootstrap documentation #90

Open
plastikfan opened this issue Jan 10, 2021 · 10 comments
Open

Create github-pages jekyll/bootstrap documentation #90

plastikfan opened this issue Jan 10, 2021 · 10 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@plastikfan
Copy link
Collaborator

plastikfan commented Jan 10, 2021

Probably on github docs/pages, with a theme

https://guides.github.com/features/wikis/

Also see

@plastikfan plastikfan added the documentation Improvements or additions to documentation label Jan 10, 2021
@plastikfan plastikfan self-assigned this Jan 10, 2021
@plastikfan
Copy link
Collaborator Author

@plastikfan
Copy link
Collaborator Author

The articles are available here:

@plastikfan
Copy link
Collaborator Author

plastikfan commented Jul 23, 2021

Actually for the sake of learning web dev/git-hub pages, bootstrap-4.5.3/css/jekyll, I am going to create a new repo that creates the documention for this repo. In that repo, I will create very small scoped commits, that would be too granula for this repo and would clutter up the commit history with micro level commits. I would rather have this commit history in a separate 'student' repo that can be used as a reference for learning purposes.

Once the documentation is at a certain desirable level, I will simply copy it over to this one.

@plastikfan plastikfan changed the title Create alternative documentation Create github-pages jekyll/bootstrap documentation Jul 23, 2021
@plastikfan
Copy link
Collaborator Author

plastikfan commented Jul 23, 2021

PS, for static site generation, bootstrap-4 uses jekyll, but bootstrap-5 uses hugo bootstrap 4 vs 5.

For the sake of not putting more barriers in my path, I will stick to BS-4 for this repo and will migrate to using Hugo/BS-5 for other repos.

@plastikfan
Copy link
Collaborator Author

This is a good reference: create a static gh-pages bootstrap website.

Also, How to create documenttion

The problem I'm having with my original approach is that using bootstrap without a theme is still too difficult; eg, how do I create a sidebar with references to pages. I need this to already be there so I can just use it.

@plastikfan
Copy link
Collaborator Author

plastikfan commented Jul 27, 2021

Here is a free theme with a sidebar, however its for bootstrap 5.

But here is a bootsrap admin theme, and because its an admin theme, it alrady contains sidebar

@plastikfan
Copy link
Collaborator Author

plastikfan commented Jul 27, 2021

It might be beter to use: just-the-docs as its designed for jekyll

I'm not sure if bootstrap and jekyll are mutually exclusive, I dont think they are, but when ever I find a infomation about a bootstrap theme/template, it's generally not for jekyll, and when I find something for jekyll (like this one) I'm not sure if it comes with bootstrap.

Here's some themes:

@plastikfan
Copy link
Collaborator Author

plastikfan commented Aug 2, 2021

✨ Arggh, I've finally found what I've been looking for, use docusaurus, which is a static website generator for gh-pages designed for powershell modules, or another option is gitbook, which actually has a better aesthetic than docusaurus.

@plastikfan
Copy link
Collaborator Author

Possible gatsby themes Starters Next or Starters:

@plastikfan
Copy link
Collaborator Author

plastikfan commented Oct 6, 2021

There is a basic gatsby theme that includes bootstrap 5 here

Also, to convert a starter into a theme, see: Converting a starter

And: gatsby-gitbook-starter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant