Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ghost1372 committed Nov 14, 2024
1 parent bdd3eda commit 521b68c
Show file tree
Hide file tree
Showing 136 changed files with 14,629 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.DS_Store
Thumbs.db
db.json
*.log
node_modules/
public/
.deploy*/
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "themes/next"]
path = themes/next
url = https://github.com/theme-next/hexo-theme-next.git
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 WinUICommunity
Copyright (c) 2021 Mahdi Hosseini

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
# WinUICommunity.github.io
# Documents

This repository contains documentation for all products such as HandyControl, WinUICommunity and others.

> [!TIP]
> The documents are written in `Markdown` files and converted into a static website by [Hexo](https://hexo.io/) (A fast, simple & powerful blog framework).
# Contribute
Contributions (PR) are welcomed!
fork our repo and Add/Edit Files and make a request.

# How to Run?

1. Download and Install [NodeJs](https://nodejs.org)
2. After Installing NodeJs, you should Install `Hexo`
Open Terminal and Enter Following Command:

```
npm install hexo-cli -g
```

3.Go to Documentation Folder (Root Folder) and Enter Following Command:

for Generating files:

```
Hexo g
```

for testing in local:

```
hexo server
```

> [!Note]
> After the publish operation (That I will do), the changes will be made on the following [repository](https://github.com/ghost1372/ghost1372.github.io) and will be publicly visible on the [ghost1372.github.io](https://ghost1372.github.io/) site
Loading

0 comments on commit 521b68c

Please sign in to comment.