Update README.md
This commit is contained in:
		
							parent
							
								
									c152a10406
								
							
						
					
					
						commit
						74de2e20a1
					
				
							
								
								
									
										59
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										59
									
								
								README.md
									
									
									
									
									
								
							| @ -1,54 +1,19 @@ | |||||||
|  | # Mastodon embed timeline | ||||||
| 
 | 
 | ||||||
| --- | Embed a mastodon feed timeine in your page, with just html, css and js. | ||||||
| 
 | 
 | ||||||
| Example plain HTML site using GitLab Pages. | Working version used at: | ||||||
|  | https://www.idotj.com | ||||||
| 
 | 
 | ||||||
| Learn more about GitLab Pages at https://pages.gitlab.io and the official | ## User guide | ||||||
| documentation https://docs.gitlab.com/ce/user/project/pages/. |  | ||||||
| 
 | 
 | ||||||
| --- |  | ||||||
| 
 |  | ||||||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> |  | ||||||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |  | ||||||
| **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)* |  | ||||||
| 
 |  | ||||||
| - [GitLab CI](#gitlab-ci) |  | ||||||
| - [GitLab User or Group Pages](#gitlab-user-or-group-pages) |  | ||||||
| - [Did you fork this project?](#did-you-fork-this-project) |  | ||||||
| - [Troubleshooting](#troubleshooting) |  | ||||||
| 
 |  | ||||||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> |  | ||||||
| 
 |  | ||||||
| ## GitLab CI |  | ||||||
| 
 |  | ||||||
| This project's static Pages are built by [GitLab CI][ci], following the steps |  | ||||||
| defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): |  | ||||||
| 
 |  | ||||||
| ``` |  | ||||||
| image: alpine:latest |  | ||||||
| 
 |  | ||||||
| pages: |  | ||||||
|   stage: deploy |  | ||||||
|   script: |  | ||||||
|   - echo 'Nothing to do...' |  | ||||||
|   artifacts: |  | ||||||
|     paths: |  | ||||||
|     - public |  | ||||||
|   only: |  | ||||||
|   - master |  | ||||||
| ``` |  | ||||||
| 
 |  | ||||||
| The above example expects to put all your HTML files in the `public/` directory. |  | ||||||
| 
 |  | ||||||
| ## GitLab User or Group Pages |  | ||||||
| 
 |  | ||||||
| To use this project as your user/group website, you will need one additional |  | ||||||
| step: just rename your project to `namespace.gitlab.io`, where `namespace` is |  | ||||||
| your `username` or `groupname`. This can be done by navigating to your |  | ||||||
| project's **Settings**. |  | ||||||
| 
 |  | ||||||
| Read more about [user/group Pages][userpages] and [project Pages][projpages]. |  | ||||||
| 
 | 
 | ||||||
| ## Licensing | ## Licensing | ||||||
| 
 | 
 | ||||||
|  | 
 | ||||||
|  | ## Improve me | ||||||
|  | 
 | ||||||
|  | Feel free to add a chaching layer, improve the styles and add more features. | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 i.j
						i.j