This repository hosts the source code for my personal portfolio website, built using the Hugo static site generator, swagger, github actions, and a few other bits and pieces. It features a fast and efficient framework to showcase my writing samples, projects, and technical documentation expertise.
The website highlights my skills in:
- Technical writing for developer and user documentation
- REST API documentation
- Markdown, Git, and version control practices
- Creating and maintaining static websites using Hugo
- (formerly) Use of GitHub workflows for automating deployments
- (currently) Use of Netlify for automating deployments and hosting this site.
This site uses the Docsy theme, a responsive and flexible theme optimized for technical documentation. The website is designed to provide clear and structured information with an emphasis on readability and easy navigation.
- Writing Samples: A showcase of my professional technical writing projects, including API documentation and user guides.
- Automated Release Notes: Integration with GitHub workflows to generate and publish release notes.
- Responsive Design: Optimized for viewing on various devices, including desktop, tablet, and mobile.
- Mermaid Diagrams: Utilized for visual representations of workflows, providing clear insight into complex technical processes.
- Markdown Support: All content is written in Markdown, ensuring a clean and efficient workflow.
The site is built with Hugo, a fast and flexible static site generator. The content is structured in markdown and can be easily updated. I leverage GitHub workflows to automate the deployment process, ensuring that new content is published without manual intervention.
To run this site locally for testing or further development, follow these steps:
-
Install Hugo: Download and install Hugo by following the instructions here.
-
Clone this repository:
git clone https://github.com/danfinn5/danfinn5.github.io.git cd danfinn5.github.io -
Run Hugo: Start the Hugo server to see the changes live in your browser.
hugo server
-
View the site: Open your browser and navigate to
http://localhost:1313to view the site locally.
The site is deployed using GitHub Pages. The publish_dir is set to the docs/ directory for smooth integration with GitHub Pages. The process is automated through GitHub workflows, ensuring that the latest updates are reflected on the live site.
If you find any issues or have suggestions for improving the site, feel free to open an issue or submit a pull request. I welcome feedback and contributions to improve the website.