# MarkdownNote

**Repository Path**: yangdongge/MarkdownNote

## Basic Information

- **Project Name**: MarkdownNote
- **Description**: 轻量级的在线笔记系统
- **Primary Language**: PHP
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2018-10-24
- **Last Updated**: 2024-07-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MarkdownNote

#### 项目介绍
MarkdownNote 是一个PHP的轻量级云记事本系统，使用sqlite3的存储方式，是方便下载就可以使用。
#### 软件架构

![](contruct.png)

软件架构说明
> app 是项目的核心目录，所有的后端程序都在此处开发

> controller 控制器目录

> model 模型目录

> util 一些工具类类

> functions 全局函数

> config 配置文件

> resource 资源文件

> runtime 缓存目录及log

#### 安装教程

1. 直接下载 git clone https://gitee.com/yangdongge/MarkdownNote.git 
2. composer install 安装扩展库

#### 使用说明

1. 使用的sqlite3 确保环境已安装php的sqlite3扩展及sqlite3
2. 直接访问 http://xxx.com/index.php就可以了
3. 在配置文件里支技两种方式的访问，一种传统的 http://xxx.com/index.php?act=index&mod=index
一种是 http://xxx.com/index/index 所以可以根据自己的环境来选择哪种方式
4. 第二种需要在nginx里做一些配置

```
server {
    listen           80;
    server_name      xxx.com; #本地域名
    root             /wwwroot/makeNoteDev; #代码路径
    index            index.php index.html index.htm;
    try_files        $uri $uri/ @rewrite;

    location @rewrite {
        rewrite ^/(.*)$ /index.php?_url=/$1; #隐藏index.php
    }

    #支持pathinfo
    location ~ \.php {
        fastcgi_pass                  unix:/run/php/php7.2-fpm.sock;
        fastcgi_index                 /index.php;
        fastcgi_split_path_info       ^(.+\.php)(/.+)$;
        fastcgi_param PATH_INFO       $fastcgi_path_info;
        fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include                       fastcgi_params;
    }

    #可以配置自己静态资源的访问路径
    location ~* ^/(css|img|js|flv|swf|download)/(.+)$ {
    }

    location ~ /\.ht {
         deny all;
    }
}

```
5. 我对于css和html不是特别的在行，所以使用这位[冒泡鱼](https://gitee.com/shawn52/MarkNote.git "冒泡鱼")同学相关的css和html


### 功能说明

1. 使用的editor 可以实时的预览
2. 支持自动保存，ctrl+s保存
3. 关于markdown 的使用语法，可以在网上搜索一下，这里就不细说了。