This is the source code for the website of Bushwick Ayuda Mutua, located at https://bushwickayudamutua.com/.
This website is built using a framework called jekyll which allows you to write human-readable markdown documents which are rendered as HTML. A markdown document is just a text file with some special syntax for declaring links, lists, headers, bold text, etc. For instance, our privacy, safety, and calendar pages are all composed in markdown. You'll notice you can also write plain html in markdown, which is how we embed some iFrames from other services. These files also include metadata at the top of the file (separated by ---) including the title of the page, the layout (will usually be info), and the permalink which controls the URL of the resulting page.
You can easily add and edit markdown files in Github's interface. Once you finish making your changes, add a commit messages describing them and submit it. The website should update to reflect your changes within 5-10 minutes!
To upload files to the resources directory of the website, navigate to it in Github's interface here and click the "Add file" button which allows you to drag-and-drop files from your computer.
Make sure to remove all spaces and other punctuation from the file names before uploading them as they can cause the resulting URLs to be difficult to share. A good standard to follow is:
- Only use lowercase letters and numbers
- Use the
-symbol for spacing - Include the document format at the end
- For instance:
mutual-aid-guide.pdf
When the files finish uploading, you can add a commit message to describe the changes you made.
When uploading documents, always try to use lower compression settings and sizes so they'll load fast on phones and poor internet. Try to follow these file-format standards:
- Images: use
jpgorpng - Video: use
mp4 - Audio: use
mp3 - Documents: use
pdf - Folders of multiple files: use
zipcompression
Once the files have uploaded, they will become publicly available on the website in 5-10 minutes. You can then update the resources page with links and descriptions of the new documents.
You'll need node for npm, and ruby and jekyll. We're currently running these versions:
node:v14.18.1npm:6.14.15ruby:3.0.2p107jekyll:
You should be able to install these on Mac OS X by running the following series of commands:
brew install ruby node@14
gem install bundlerNow clone the repo, go to the folder in your terminal and run bundle exec make serve.
When it's running, go to https://localhost:4000 on your browser.
If you'd like to get involved with BAM, please fill out our volunteer form and we'll be in touch!