https://github.com/ljsabc/showmyresearches
Showcase your researches into modern web pages with Markdown.
https://github.com/ljsabc/showmyresearches
pugjs research-data-management tailwindcss
Last synced: 5 months ago
JSON representation
Showcase your researches into modern web pages with Markdown.
- Host: GitHub
- URL: https://github.com/ljsabc/showmyresearches
- Owner: ljsabc
- License: mit
- Created: 2019-11-23T01:27:27.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-03T04:34:49.000Z (over 4 years ago)
- Last Synced: 2025-05-14T21:11:56.584Z (6 months ago)
- Topics: pugjs, research-data-management, tailwindcss
- Language: HTML
- Homepage: https://moeka.me/research.html
- Size: 3.87 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ShowMyResearches
----
## Overview
This is a very simple toolkit based on Markdown to generate your research project showcases. This tool features:
+ Markdown support for super-easy page generation
+ Predefined responsive styles with tailwind.css
+ Customizable single-project page, with responsive themes
## How to use
We have present you two template files:
1. index.md (for generate card-based project views, we assume you can write basic Markdown documents)
2. singlePage/colorize.html (for generate single project page. You can simply paste to replace, or customize your own components)
Note that only files mentioned in index.md will be generated to the final build folder. ALL HTML files uses *index.css* as style reference so it includes both overall-view and singlePage view. Replace the file(s) with your own and move to the next step.
## Build
Once you have prepared the pages, just run
yarn
yarn run build
The project folder will locates in the *build/* folder. Copy to your web server and it works >w<.
## Screenshot
