mdzip-core 0.1.0

Read and write MDZip (.mdz) archives: Markdown documents and their images in one portable file.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

[
  {
    "name": "simple markdown path is valid",
    "path": "index.md",
    "valid": true
  },
  {
    "name": "nested asset path is valid",
    "path": "assets/images/cover.png",
    "valid": true
  },
  {
    "name": "leading slash is invalid",
    "path": "/index.md",
    "valid": false,
    "errorCode": "ERR_PATH_LEADING_SLASH"
  },
  {
    "name": "path traversal is invalid",
    "path": "../escape.md",
    "valid": false,
    "errorCode": "ERR_PATH_TRAVERSAL"
  },
  {
    "name": "dot-dot segment in the middle is invalid",
    "path": "docs/../index.md",
    "valid": false,
    "errorCode": "ERR_PATH_TRAVERSAL"
  },
  {
    "name": "trailing dot-dot segment is invalid",
    "path": "docs/..",
    "valid": false,
    "errorCode": "ERR_PATH_TRAVERSAL"
  },
  {
    "name": "dot-dot inside a file name is valid",
    "path": "notes..md",
    "valid": true
  },
  {
    "name": "dot-dot inside a folder name is valid",
    "path": "v1..2/notes.md",
    "valid": true
  },
  {
    "name": "reserved character is invalid",
    "path": "chapter:01.md",
    "valid": false,
    "errorCode": "ERR_PATH_RESERVED_CHAR"
  },
  {
    "name": "backslash separator is invalid",
    "path": "assets\\cover.png",
    "valid": false,
    "errorCode": "ERR_PATH_RESERVED_CHAR"
  },
  {
    "name": "control character is invalid",
    "path": "bad\u0001name.md",
    "valid": false,
    "errorCode": "ERR_PATH_CONTROL_CHAR"
  },
  {
    "name": "leading dot segment is invalid",
    "path": "./index.md",
    "valid": false,
    "errorCode": "ERR_PATH_INVALID"
  },
  {
    "name": "dot segment in the middle is invalid",
    "path": "docs/./intro.md",
    "valid": false,
    "errorCode": "ERR_PATH_INVALID"
  },
  {
    "name": "empty segment is invalid",
    "path": "docs//intro.md",
    "valid": false,
    "errorCode": "ERR_PATH_INVALID"
  }
]