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

Created a Vigilant logo and added a documentation site #191

Closed
wants to merge 23 commits into from

Conversation

hazzuk
Copy link
Contributor

@hazzuk hazzuk commented May 12, 2024

hazzuk github io_vigilant_

hazzuk.github.io/vigilant

Description

Created a new logo for Vigilant, taking some small inspiration from the RSS logo. Added a documentation site using the existing markdown guides, powered by Docsify. Fully automatic deployment with GitHub actions.

Changes

README

  • Add a Vigilant logo and icons
  • Add references to running Vigilant with Docker
  • Update file paths for Docsify compatibility

Docsify

  • Setup Docsify directory
  • Copy Create symlinked README in ./docs to be used in the documentation
  • Create cover landing page
  • Add sidebar navigation
  • Add link to CHANGELOG, to be used directly in the docs
  • Create a page explaining Docsify setup

Related Issues

  • Once the documentation is setup in VerifiedJoseph/vigilant with GitHub pages. Changes need to be made to the logo used in the README. Both the img src= and a href= changed to verifiedjoseph.github.io.
  • I created a docsify.md page, explaining how to setup Docsify locally and with GitHub pages. Was unsure if or where to add a link to this in the README. If you would like to-do so, then use something like [Documentation setup](docs/docsify.md).
  • A link to the docs should be added to the GitHub repo once the documentation site is created.
  • Important note, when running Docsify locally, the set basepath causes the site to break (as GitHub pages always uses a sub path). Hopefully one day they will fix this issue, read docisfy.md for steps.

Testing

  • Desktop Windows Chromium
  • Mobile iOS Safari Webkit

@hazzuk
Copy link
Contributor Author

hazzuk commented Sep 8, 2024

@VerifiedJoseph Thank you for adding my suggested features in 1.3/1.4, they'll be very handy to have.

I've merged some small changes with main and made an additional tweak.

@VerifiedJoseph
Copy link
Owner

VerifiedJoseph commented Oct 15, 2024

Apologies for not responding to your pull request soon @hazzuk. After giving this some thought I've decided that MkDocs and Material for MkDocs are a better fit for the docs site (see #277).

I greatly appreciate the work you've done and I would like to use the logo you've designed (with due credit) for the project.

@hazzuk
Copy link
Contributor Author

hazzuk commented Oct 15, 2024

@VerifiedJoseph I've previously used Material for MkDocs myself, that's a great pick!

I've created a new PR for including the logo in the MkDocs site here #278

@hazzuk hazzuk closed this Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants