Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 5.05 KB

README.md

File metadata and controls

61 lines (50 loc) · 5.05 KB
Raw

project-website-template

Demo: https://yenchiah.github.io/project-website-template/

The current version is v3.36, and the last known stable version is v3.29.

This is a responsive (mobile/desktop) and light-weight HTML/CSS template for building projects or personal websites. If your website does not require complex user interactions, I recommend starting with the empty template (empty.html) and copy codes from the file that contains different layouts (index.html). For building interactive websites, this library also provides several widgets (widgets.html) based on jQuery and jQuery UI. Examples that use this template are:

If you would love to keep updating this template, please keep your codes in separate files (custom.css and custom.js) and avoid modifying the following:

  • css/frame.css (CSS for the main frame of the website)
  • css/controls.css (CSS for control elements that do not require JavaScript)
  • css/widgets.css (CSS for widgets that require JavaScript)
  • js/widgets.js (JavaScript for widgets)
  • js/util.js (JavaScript for general utility functions)
  • js/menu.js (JavaScript for loading the menu bar)

From version 3.0, the menu bar at the top is moved into a single file (menu.html) for better management. Each template page will now use jQuery to load the menu bar file (menu.js), as shown below:

<script src="js/menu.js"></script>

If your website is static and requires no user interactions, I recommend copying the code from the menu file (menu.html) into the menu-container div in your html template.

<div class="menu-container">
  [copy everything in the menu.html and paste the code here]
</div>

In this way, you can remove the script line that loads jQuery in the header of the html and also delete the files for loading the menu bar (menu.html and menu.js).

This template is tested and worked on:

  • macOS 12.4
    • Chrome 103
    • Safari 15.5
    • Firefox 103
    • Edge 103
  • Android 12
    • Chrome 103
  • iOS 15.5
    • Chrome 103
    • Safari 15.5
    • Firefox 102

Problems and Bugs

Here are the problems and bugs that I plan to address in the future. If you fixed them, please do not hesitate to send me a pull request, and I would be very grateful. Please also report problems and bugs in GitHub Issues.

  • On mobile Safari, the menu on the top will not close after opening it. This is because the menu icon on mobile Safari retains focus after a touch event, and the menu relies on the loss of focus event of the icon to close.
  • On Safari, the survey question that asks users to select photos will display the photos in a weird way after clicking on the checkbox. The reason for this problem is unknown.

Future Plans for Feature Enhancement

Here are several features that I plan to add in the future. If you wish to contribute, please email me to discuss the design before submitting pull requests.

  • A slideshow block for showing images or videos

Policy for Open Source Contribution

I welcome and appreciate contributions in fixing bugs and enhancing features. However, please avoid submitting pull requests (PRs) that modify the template's existing design without discussing them with me. Please do not submit PRs that are not related to bug fixes or feature enhancements. Editing text in the README file is not encouraged (e.g., fixing grammar errors). PRs with unnecessary editing (e.g., adding unrelated text, changing the design of the template, modifying the README text arbitrarily) or unrelated changes (e.g., changes that are related to only their applications) will be marked as "spam" and "invalid".

If you are excited to contribute to the new features directly, please explain your design decisions and how your design matches this template's style in the PR. If you fix bugs, please explain which bug you fixed and how you fixed them. The explanations that you put in each PR can greatly help me determine if the changes can be merged into the master branch. PRs with no explanations will highly likely be rejected and marked as "wontfix".