You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-7Lines changed: 17 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,16 @@
1
1
# stemformulas
2
-
Welcome to [https://stemformulas.com/](https://stemformulas.com/), the site with the goal of being the best place in the world to look for STEM-related
Welcome to [https://stemformulas.com/](https://stemformulas.com/), the site with the goal of being the best place in the world to look for STEM-related formulas.
6
+
7
+
## Features:
8
+
- 63 formulas and counting (we gotta pump those numbers up)
9
+
- The search bar is in focus on site load for quick searching
10
+
- The / key can be used to open the search on any page
11
+
- LaTeX can be copied by clicking on it on any formula's page
12
+
- The site has open-graph tags, so a full preview of the formula is shown when its page is shared on social media
13
+
- The site is mobile-friendly
6
14
7
15
## How to contribute:
8
16
@@ -22,7 +30,7 @@ Setting up this repository locally only requires Git and Docker, and it's honest
2. Install the latest version of [Docker Desktop](https://www.docker.com/products/docker-desktop/) and run it. `docker info` should work on your command line.
33
+
2. Install the latest version of [Docker Desktop](https://www.docker.com/products/docker-desktop/) and run it. `docker info` should work on your command line when Docker is properly set up and running.
26
34
27
35
3. Run the site and helper site with Docker in a terminal (in the root directory of this repository):
The first command runs the site, and the second monitors for file changes to sync them to the Docker container. You should be able to visit the site at `localhost:1313` in your browser, and changes to files in the `content` folder should be reflected on the site (e.g. open the about page and then modify content/about/_index.md).
33
41
34
-
4. If you ran the docker compose command you should also have a Python applet I wrote up at `localhost:8501` in your browser. This is a GUI that helps you write 70% of formula pages. You can read more about it in the ChatGPT workflow section at the bottom of this README.
42
+
4. If you ran the docker compose command you should also have a Python applet I wrote up at `localhost:8501` in your browser. This is a GUI that helps you write the tedious parts of a formula's page. You can read more about it in the ChatGPT workflow section at the bottom of this README.
35
43
36
44
37
45
## Adding a formula
38
46
With the site running locally, you can now add a formula page to the site and preview how it'll look on the actual site.
39
-
Here are the steps for adding a formula:
47
+
Here are the steps for adding a formula (mostly git instructions):
40
48
41
49
1. In another terminal, create a new branch for your changes:
42
50
@@ -81,6 +89,8 @@ I use ChatGPT and a custom Python GUI to help me write formula pages. Here's how
81
89
3. Copy the reply from ChatGPT and paste it into the second tab of the Python GUI, which will fix some of the LaTeX formatting. This can usually now be put into an index.md file, with all of the grunt work done. Make sure to fully proofread what ChatGPT gives you, as it is crucial that formulas put on the site are correct.
0 commit comments