Skip to content

osdc/Mercurius

Folders and files

NameName
Last commit message
Last commit date

Latest commit

feaa1b4 Β· Dec 5, 2023

History

27 Commits
Apr 24, 2021
Apr 18, 2021
Nov 18, 2023
Oct 21, 2023
Nov 26, 2023
Jun 10, 2021
Apr 18, 2021
Nov 14, 2023
Apr 18, 2021
Oct 21, 2023
Nov 18, 2023
Jun 10, 2021
Jun 10, 2021
Jun 10, 2021

Repository files navigation

Mercurius

A Community Newsletter Initiative developed and maintained by OSDC

Setting up locally πŸš€

  • Install hugo on your system (steps vary with different OS). For convenience, refer this link.
  • Download and install NodeJs from here
  • Fork and clone the project and follow these steps
    • cd Mercurius && npm i to install npm based dependencies.
    • hugo serve to start the local development server (localhost/port details will be available in console).
    • To send out mail notifications, update email list from scripts/mail-scripts/emails.json followed by cd scripts/mail-scripts && go run main.go (though the email list and credentials needed to authenticate this operation will be confidential to maintainers only).
    • Email template for the mail to be sent is written in HTML format and is super-easy to edit. You can contribute changes to it from scripts/mail-scripts/email_body.html,

Blog Submissions πŸ“–

  • Head to content/post
  • Write the blog that you wish to publish in a md file and save it this folder.
  • Be sure to include the header at the start of you blog's md (check content/post/Example1.mdfor more).
  • Create a PR and notify the maintainers if your blog doesn't get published within a week.