Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
markdown-dissertation/Example/Use.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
73 lines (48 sloc)
1.88 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Using the Template | |
## Step 1: Modify the **Dissertaion.md** file. | |
This file contains the metadata used to generate the title page etc. | |
There isn't a huge amount that needs changing here, and it should be | |
self explanatory. | |
~~~ {.yaml} | |
# ----- THINGS THAT YOU NEED TO CHANGE ---- | |
author: "Your Name" | |
title: "Project Title" | |
# Keywords associated with your project | |
keywords: Comma, Seperated, Keywords | |
degreetitle: 'BSc: Ethical Hacking and cybersecurity' | |
# Ethics form, REPLACE THIS WITH YOUR ONE | |
PDF-ethics: Supporting/ethics-certificate.pdf | |
# Origianlity Statement: REPLACE THIS WITH YOURS | |
PDF-declaration: Supporting/submission-declaration.pdf | |
# Finally the Bibtex file for your references. | |
bibliography: example-bib.bib | |
# Font to use (I would leave this) | |
fontfamily: helvet | |
~~~ | |
## Step 2: Create some Content | |
You next need to create any content. | |
I would recommend creating *One file per chapter* | |
A Basic Markdown Primer can be found in [LINK] | |
I am also putting together some docs on how I go about writing things | |
## Step 3: Modify the Build script | |
You will also need to modify the script that builds the dissertation **Build.py** | |
As with the config file, there are only a couple of lines that you should need to change. | |
- Add any source files to the list of source files | |
- If you want, modify the name of the output file | |
~~~ {.python} | |
# --------------- CHANGE THESE TWO LINES ------------------------- | |
OUTPUT_FILE = "Disso.pdf" | |
#ENTER ALL THE SOURCE FILES THAT YOU HAVE IN THE DISSERTAION HERE. | |
SOURCE_FILES = ["EG-Intro.md"] | |
# --------------- END OF STUFF THAT YOU NEED TO CHANGE ------------------------- | |
~~~ | |
## Step 4: Build the Document | |
We can now build the document using the script | |
Either on the Command line. | |
~~~ | |
python Build.py | |
~~~ | |
Or by double clicking in you like Window Managers. | |
## Optional: | |
- Commit all your files using Git | |
- Share the repository with your supervisor |