1. Introduction
This website was created to offer users a place to write and submit academic work which can serve as an alternative to standard publication platforms. It is meant to facilitate sharing information, discussing results, and providing a forum for article review. The hope is that someday soon the only thing it won't be able to do for you is get you tenure.
2. Basic Article Fields
When creating a new article, you'll need to provide:
- Title: A descriptive title for your article
- Content: The main body of your article (written in Markdown)
- Communities: Select at least one community to publish your article to
- Tags: Comma-separated tags to help categorize your article
- BibTeX File: (Optionally) upload a BibTeX file for citations
The rest of this article will concern the Content field in particular, including bespoke commands for image embedding and interacting with your BibTeX file. Other articles will be written soon to describe how to use other features of this site.
3. Formatting with Markdown
Content is the most important feature of your article, it is the main body of text. For the most part, our platform uses standard Markdown syntax for formatting:
# Heading 1
## Heading 2
### Heading 3
**Bold text**
*Italic text*
\> Blockquote
- Bullet point 1
- Bullet point 2
1. Numbered item 1
2. Numbered item 2
[Link text](https://example.com)
4. Adding LaTeX Equations
No self-respecting academic could bear to publish on a site that didn't offer LaTeX formatting for equations. For this reason we use MathJax to render
- For inline equations, use single dollar signs:
$E = mc^2$
: $E = mc^2$ - For display equations, use double dollar signs:
$$\frac{d}{dx}\left( \int_{0}^{x} f(u)\,du\right)=f(x)$$
$$\frac{d}{dx}\left( \int_{0}^{x} f(u)\,du\right)=f(x)$$
To avoid accidental formatting be sure to use the \ escape character to precede a "normal" dollar sign.
5. Image Uploading and Embedding
Users can also upload images. Because of the nature of academic work we operate from the assumption that one image may need to be referenced multiple times. Therefore, there is a separate section dedicated to uploading and hosting images. This can then be used to embed the images.
How to Upload Images
- Navigate to the "Images" section
- Click "Upload New Image"
- Fill in the required fields:
- Title
- Image file (JPEG or PNG, max 5MB)
- Description (supports Markdown)
- Select at least one community
- Optional tags
Embedding Images in Articles
To embed an image in your article, use the following syntax:
[[Image:123]]
Where 123
is the ID of the image you want to embed.
Image Formatting Options
You can customize how images appear by adding parameters:
[[Image:123|caption:This is a caption|width:50%|alignment:left]]
Available parameters:
caption
: Text to display below the imagewidth
: Width of the image (e.g., "50%", "300px")alignment
oralign
: Position of the image ("left", "center", "right")
You can also use a simpler syntax:
[[Image:123|This is a caption]]
3. Citations
Using BibTeX for Citations
- Prepare a BibTeX file with your references (max 1MB)
- Upload the file when creating or editing your article
- In your article content, cite references using the syntax:
[@citation_key]
Example BibTeX entry:
@article{smith2019example,
title={Example Paper Title},
author={Smith, John},
journal={Journal of Examples},
year={2019},
volume={42},
pages={123--456}
}
To cite this in your article:
As shown by [@smith2019example], the results are significant.
Citing Internal Articles
You can cite other articles on the platform using the same syntax:
According to [@article_title], this approach is effective.
The system will automatically find the article with a matching title or tag and include it in your bibliography.
Creating a Bibliography
A bibliography is automatically generated at the end of your article based on the citations you've included. Each citation will be numbered and linked to the corresponding entry in the bibliography.
4. Creating Tables
You can create tables using standard Markdown syntax:
| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
This will render as:
Header 1 | Header 2 | Header 3 |
---|---|---|
Cell 1 | Cell 2 | Cell 3 |
Cell 4 | Cell 5 | Cell 6 |
Table Formatting Options
You can align columns by adding colons to the separator line:
| Left-aligned | Center-aligned | Right-aligned |
|:-------------|:--------------:|--------------:|
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
This will render with the specified alignments:
Left-aligned | Center-aligned | Right-aligned |
---|---|---|
Cell 1 | Cell 2 | Cell 3 |
Cell 4 | Cell 5 | Cell 6 |