vuepress static site generater added

[cijagani]

to generate site follow this steps.

1. go to project root directory
2. yarn install (it will install dependancies)
3. npm run docs:dev (this command will compile .md and it will start node server)

[cijagani]

4. to Deploying doc file run npm run docs:build
   more informations can be found here

[cijagani]

Didn't received any reply since long time. so i am closing this PR.

[MGatner]

I'm afraid I'm not familiar with VuePress so this PR never had any context for me. If this is something you previously discussed with @lonnieezell you should bring it up with him.

[kenjis]

I don't know VuePress well, but I want to ask why VuePress?

[datamweb]

I'm not familiar with VuePress GitHub either, from a quick look at the docs I found it's a good tool, also very popular with developers.
Let @cijagani give us more details.

[lonnieezell]

VuePress might be a decent option, I haven't looked into it. I do think it would be good to get small sub-sites up for these packages, but none of us have had time to do it. When we do that, though, I imagine something like Jekyll that is directly supported by GitHub Pages is probably the route we would want to take.

[cijagani]

@kenjis @datamweb
here is the Key Features of VuePress

• Built-in markdown extension optimized for technical documentation
• Ability to take advantage of Vue code embedded in markdown files
• Vue-driven custom theme system
• Automatically generate Service Worker
• Google Analytics integration
• Git-based “recent update”
• Multi-language support
• A default theme with dark mode option
• SPA (single page application)
• Responsive layout
• Optional home page
• Simple, out-of-the-box, title-based search
• Algolia search
• Customizable navigation bar and sidebar
• Automatically generated GitHub links and page edit links

more details can be found here.

[cijagani]

@lonnieezell yes Jekyll is also good option.

[kenjis]

Why not Jekyll?
Do you have a reason?

[datamweb]

@kenjis I don't disagree with Jekyll, I read a bit about it today after lonnieezell introduced Jekyll.
I trust lonnieezell decisions and I'm sure he has logical reasons for his decisions.
Do you have the necessary mastery of Jekyll?

@cijagani Thank you for your reply.
From your reply, I realized that your PR goal was to improve Shield documents and that you have no particular bias. Thank you for this.

[lonnieezell]

I don’t have any experience with either of them but I want it to be as simple to integrate into GitHub actions as possible. I would have to check into any solution and how easy to integrate it is for automatic builds.

…

Sent from my iPhone

On Aug 31, 2022, at 4:45 PM, Pooya Parsa Dadashi ***@***.***> wrote:  @kenjis I don't disagree with Jekyll, I read a bit about it today after lonnieezell introduced Jekyll. I trust lonnieezell decisions and I'm sure he has logical reasons for his decisions. Do you have the necessary mastery of Jekyll? @cijagani Thank you for your reply. From your reply, I realized that your PR goal was to improve Shield documents and that you have no particular bias. Thank you for this. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.

[kenjis]

GitHub Pages supports Jekyll.
https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll

[datamweb]

Well, it wasn't as hard as I thought, I think this is what you want.
Of course, it needs some changes, also we need a subdomain, for example shield.codeigniter.com,
I will try to work a little more to have a complete understanding of this topic.
Of course, if everyone agrees with this change.
https://datamweb.github.io/ShieldSite/

[kenjis]

See https://kenjis.github.io/codeigniter-shield/

Just setting on the repository, after it, alll we need to do is to customize theme.

[datamweb]

Just setting on the repository, after it, alll we need to do is to customize theme.

I wonder, it was wonderful.
After the configuration, we can edit and update only the anyfile.md files as before. This is great.
just-the-docswas also interesting for me. It also has a search box.

[lonnieezell]

Wow that looks like a lot easier than I thought it would be! That's definitely something we can work with. Thanks for exploring these everyone. Hopefully we can get a theme that is similar in feel to the main docs, though I don't imagine we'll get the same layout. Guess We'll need to update the index page with some About Shield information, too.

[lonnieezell]

Here's a list of supported themes. I think Slate and Tactile are my favorites but I'd love to hear what everyone thinks. Dinky could be decent, also, with a little customization.

[MGatner]

I have a strong bias for white backgrounds on documentation. It's the best for quick reading and I need my docs to be incredibly utilitarian. Almost all these themes are grey background - maybe we could change that one aspect though? My specific thoughts:

• Like Lonnie I enjoy Slate, minus the background
• Cayman has an almost-white background and good typography, overall pleasant
• Time Machine to me is the most utilitarian (while still being appealing) except the preview site has some responsive issues on mobile (maybe that's just an issue with the preview?)

[kenjis]

I think we can use custom CSS.
See https://github.com/pages-themes/architect#stylesheet

[lonnieezell]

Once we get a PR merged for this I can setup the sub-domains.