mirror of
https://github.com/liyunze-coding/coworking-website.git
synced 2026-11-06 21:23:33 +00:00
updated README
This commit is contained in:
parent
89a0f65e07
commit
077306e2a8
3 changed files with 103 additions and 3 deletions
104
README.md
104
README.md
|
|
@ -1,8 +1,24 @@
|
|||
<div align="center">
|
||||
|
||||
# Coworking Guide
|
||||
|
||||
[](https://coworking-guide.vercel.app/)
|
||||
[](https://coworking-guide.vercel.app/)
|
||||
|
||||
hello
|
||||
<div style="display:flex; gap: 0 0.3em;justify-content:center;margin-top:1em;">
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -11,8 +27,92 @@ hello
|
|||
- [Coworking Guide](#coworking-guide)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Contributing](#contributing)
|
||||
- [Directives](#directives)
|
||||
- [Frontmatter](#frontmatter)
|
||||
- [Guide Content](#guide-content)
|
||||
- [Independent Pages](#independent-pages)
|
||||
- [Blog Post](#blog-post)
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Guidelines: TBA
|
||||
|
||||
---
|
||||
|
||||
## Directives
|
||||
|
||||
```
|
||||
:::warn
|
||||
This is a warning!
|
||||
:::
|
||||
|
||||
:::note
|
||||
Note this down
|
||||
:::
|
||||
|
||||
:::success
|
||||
this was successful!
|
||||
::
|
||||
|
||||
:::danger
|
||||
It could go very wrong
|
||||
:::
|
||||
|
||||
:::tip
|
||||
This is a cool tip!
|
||||
:::
|
||||
```
|
||||
|
||||
## Frontmatter
|
||||
|
||||
### Guide Content
|
||||
|
||||
```
|
||||
---
|
||||
title:
|
||||
layout: "../../layouts/GuideLayout.astro"
|
||||
description:
|
||||
order: 0
|
||||
---
|
||||
```
|
||||
|
||||
- `title`: Page title
|
||||
- `layout`: Path to layout file
|
||||
- `description`: Description of the content
|
||||
- `order`: The order in which it displays on the left bar
|
||||
|
||||
### Independent Pages
|
||||
|
||||
```
|
||||
---
|
||||
title:
|
||||
layout: "../../layouts/GuideLayout.astro"
|
||||
description:
|
||||
---
|
||||
```
|
||||
|
||||
- `title`: Page title
|
||||
- `layout`: Path to layout file
|
||||
- `description`: Description of the content
|
||||
|
||||
### Blog Post
|
||||
|
||||
```
|
||||
---
|
||||
heading:
|
||||
subheading:
|
||||
author:
|
||||
slug: spirit-city
|
||||
pubDate: 1970-01-01T0:00:00
|
||||
---
|
||||
```
|
||||
|
||||
- `heading`: the main title
|
||||
- `subheading`: the tagline of the blog post
|
||||
- `author`: name / username of author
|
||||
- `slug`: desired URL slug
|
||||
- `pubDate`: Published date (ISO 8601)
|
||||
|
||||
---
|
||||
BIN
public/assets/coworking-website-preview.webp
Normal file
BIN
public/assets/coworking-website-preview.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
|
|
@ -5,7 +5,7 @@ const currentUrl = Astro.url.pathname;
|
|||
<ul class="list-none text-sm">
|
||||
<li class="ml-[0.5rem] my-2">
|
||||
<a
|
||||
href={`https://github.com/liyunze-coding/coworking-website/tree/main/src/pages${currentUrl}`}
|
||||
href={`https://github.com/liyunze-coding/coworking-website/edit/main/src/pages${currentUrl}`}
|
||||
class="inline-flex gap-2 transition-colors duration-150 text-white hover:no-underline hover:text-blue-400"
|
||||
>
|
||||
<svg
|
||||
|
|
|
|||
Loading…
Reference in a new issue