
Effortlessly build your personal website with SimplePlain! This template is crafted for simplicity and customization, making it the perfect choice for showcasing your portfolio.
🌐 Live Demo
·
🐞 Report Bug
·
💡 Request Feature
🚧 This project is still under construction! 🚧
Table of Contents
While there are many fantastic personal website templates available online, I couldn’t find one that perfectly matched my needs. So, I decided to create one myself! I believe SimplePlain can also benefit others who are looking to build their personal websites, which is why I’ve made it open-source.
SimplePlain is designed to help you easily showcase your portfolio or personal projects. It’s simple and minimalistic, yet flexible enough to fit your style and needs.
I plan to continue adding features and improvements based on user needs. Feel free to suggest changes, contribute, or open issues. Thank you to everyone who has helped improve and expand this template!
This project is primarily built with the following frameworks and libraries. Any additional tools or plugins are listed in the acknowledgments section.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/github_username/repo_name.git
- Install NPM packages
npm install
- Enter your API in
config.js
const API_KEY = "ENTER YOUR API";
- Change git remote url to avoid accidental pushes to base project
git remote set-url origin github_username/repo_name git remote -v # confirm the changes
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
- Add Changelog
- Add back to top links
- Add Additional Templates w/ Examples
- Add "components" document to easily copy & paste sections of the readme
- Multi-language Support
- Chinese
- Spanish
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
Pin-Yen Huang - pyhuang97@gmail.com
Project Link: https://github.com/pm25/simpleplain
I am deeply grateful for the following tools and resources that contributed to the development of this project: